Java tutorial
/******************************************************************************* * This file is part of OpenNMS(R). * * Copyright (C) 2011-2012 The OpenNMS Group, Inc. * OpenNMS(R) is Copyright (C) 1999-2012 The OpenNMS Group, Inc. * * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc. * * OpenNMS(R) is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation, either version 3 of the License, * or (at your option) any later version. * * OpenNMS(R) is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with OpenNMS(R). If not, see: * http://www.gnu.org/licenses/ * * For more information contact: * OpenNMS(R) Licensing <license@opennms.org> * http://www.opennms.org/ * http://www.opennms.com/ *******************************************************************************/ /* * This class was automatically generated with * <a href="http://www.castor.org">Castor 1.1.2.1</a>, using an XML * Schema. * $Id$ */ package com.netxforge.oss2.xml.event; //---------------------------------/ //- Imported classes and packages -/ //---------------------------------/ import java.io.Serializable; import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; import org.apache.commons.lang.builder.ToStringBuilder; /** * The varbinds from the trap * * @version $Revision$ $Date$ */ @XmlRootElement(name = "parms") @XmlAccessorType(XmlAccessType.FIELD) @Deprecated //@ValidateUsing("event.xsd") public class Parms implements Serializable { private static final long serialVersionUID = 1361348948961582446L; //--------------------------/ //- Class/Member Variables -/ //--------------------------/ /** * A varbind from the trap */ @XmlElement(name = "parm", required = true) private java.util.List<com.netxforge.oss2.xml.event.Parm> _parmList; //----------------/ //- Constructors -/ //----------------/ public Parms() { super(); this._parmList = new java.util.ArrayList<Parm>(); } //-----------/ //- Methods -/ //-----------/ /** * * * @param vParm * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection */ public void addParm(final com.netxforge.oss2.xml.event.Parm vParm) throws java.lang.IndexOutOfBoundsException { this._parmList.add(vParm); } /** * * * @param index * @param vParm * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection */ public void addParm(final int index, final com.netxforge.oss2.xml.event.Parm vParm) throws java.lang.IndexOutOfBoundsException { this._parmList.add(index, vParm); } /** * Method enumerateParm. * * @return an Enumeration over all possible elements of this * collection */ public java.util.Enumeration<com.netxforge.oss2.xml.event.Parm> enumerateParm() { return java.util.Collections.enumeration(this._parmList); } /** * Method getParm. * * @param index * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection * @return the value of the com.netxforge.oss2.core.xml.event.Parm * at the given index */ public com.netxforge.oss2.xml.event.Parm getParm(final int index) throws java.lang.IndexOutOfBoundsException { // check bounds for index if (index < 0 || index >= this._parmList.size()) { throw new IndexOutOfBoundsException( "getParm: Index value '" + index + "' not in range [0.." + (this._parmList.size() - 1) + "]"); } return (com.netxforge.oss2.xml.event.Parm) _parmList.get(index); } /** * Method getParm.Returns the contents of the collection in an * Array. <p>Note: Just in case the collection contents are * changing in another thread, we pass a 0-length Array of the * correct type into the API call. This way we <i>know</i> * that the Array returned is of exactly the correct length. * * @return this collection as an Array */ public com.netxforge.oss2.xml.event.Parm[] getParm() { com.netxforge.oss2.xml.event.Parm[] array = new com.netxforge.oss2.xml.event.Parm[0]; return (com.netxforge.oss2.xml.event.Parm[]) this._parmList.toArray(array); } /** * Method getParmCollection.Returns a reference to '_parmList'. * No type checking is performed on any modifications to the * Vector. * * @deprecated This entire class has been deprecated. Use Event.getParmCollection instead * * * @return a reference to the Vector backing this class */ public java.util.List<com.netxforge.oss2.xml.event.Parm> getParmCollection() { return this._parmList; } /** * Method getParmCount. * * @return the size of this collection */ public int getParmCount() { return this._parmList.size(); } /** * Method iterateParm. * * @return an Iterator over all possible elements in this * collection */ public java.util.Iterator<com.netxforge.oss2.xml.event.Parm> iterateParm() { return this._parmList.iterator(); } /** */ public void removeAllParm() { this._parmList.clear(); } /** * Method removeParm. * * @param vParm * @return true if the object was removed from the collection. */ public boolean removeParm(final com.netxforge.oss2.xml.event.Parm vParm) { boolean removed = _parmList.remove(vParm); return removed; } /** * Method removeParmAt. * * @param index * @return the element removed from the collection */ public com.netxforge.oss2.xml.event.Parm removeParmAt(final int index) { java.lang.Object obj = this._parmList.remove(index); return (com.netxforge.oss2.xml.event.Parm) obj; } /** * * * @param index * @param vParm * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection */ public void setParm(final int index, final com.netxforge.oss2.xml.event.Parm vParm) throws java.lang.IndexOutOfBoundsException { // check bounds for index if (index < 0 || index >= this._parmList.size()) { throw new IndexOutOfBoundsException( "setParm: Index value '" + index + "' not in range [0.." + (this._parmList.size() - 1) + "]"); } this._parmList.set(index, vParm); } /** * * * @param vParmArray */ public void setParm(final com.netxforge.oss2.xml.event.Parm[] vParmArray) { //-- copy array _parmList.clear(); for (int i = 0; i < vParmArray.length; i++) { this._parmList.add(vParmArray[i]); } } /** * Sets the value of '_parmList' by copying the given Vector. * All elements will be checked for type safety. * * @param vParmList the Vector to copy. */ public void setParm(final java.util.List<com.netxforge.oss2.xml.event.Parm> vParmList) { // copy vector this._parmList.clear(); this._parmList.addAll(vParmList); } /** * Sets the value of '_parmList' by setting it to the given * Vector. No type checking is performed. * @deprecated * * @param parmList the Vector to set. */ public void setParmCollection(final java.util.List<com.netxforge.oss2.xml.event.Parm> parmList) { this._parmList = parmList; } public String toString() { return new ToStringBuilder(this).append("parm", _parmList).toString(); } }