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 Mask for event configuration: The mask contains one * or more 'maskelements' which uniquely identify an event. This * can only * include elements from the following subset: uei, source, host, * snmphost, * nodeid, interface, service, id(SNMP EID), specific, generic, * community * * @version $Revision$ $Date$ */ @XmlRootElement(name = "mask") @XmlAccessorType(XmlAccessType.FIELD) //@ValidateUsing("event.xsd") public class Mask implements Serializable { private static final long serialVersionUID = 6553429078798831778L; //--------------------------/ //- Class/Member Variables -/ //--------------------------/ /** * The mask element */ @XmlElement(name = "maskelement", required = true, nillable = false) private java.util.List<com.netxforge.oss2.xml.event.Maskelement> _maskelementList; //----------------/ //- Constructors -/ //----------------/ public Mask() { super(); this._maskelementList = new java.util.ArrayList<com.netxforge.oss2.xml.event.Maskelement>(); } //-----------/ //- Methods -/ //-----------/ /** * * * @param vMaskelement * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection */ public void addMaskelement(final com.netxforge.oss2.xml.event.Maskelement vMaskelement) throws java.lang.IndexOutOfBoundsException { this._maskelementList.add(vMaskelement); } /** * * * @param index * @param vMaskelement * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection */ public void addMaskelement(final int index, final com.netxforge.oss2.xml.event.Maskelement vMaskelement) throws java.lang.IndexOutOfBoundsException { this._maskelementList.add(index, vMaskelement); } /** * Method enumerateMaskelement. * * @return an Enumeration over all possible elements of this * collection */ public java.util.Enumeration<com.netxforge.oss2.xml.event.Maskelement> enumerateMaskelement() { return java.util.Collections.enumeration(this._maskelementList); } /** * Method getMaskelement. * * @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.Maskelement at the given index */ public com.netxforge.oss2.xml.event.Maskelement getMaskelement(final int index) throws java.lang.IndexOutOfBoundsException { // check bounds for index if (index < 0 || index >= this._maskelementList.size()) { throw new IndexOutOfBoundsException("getMaskelement: Index value '" + index + "' not in range [0.." + (this._maskelementList.size() - 1) + "]"); } return (com.netxforge.oss2.xml.event.Maskelement) _maskelementList.get(index); } /** * Method getMaskelement.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.Maskelement[] getMaskelement() { com.netxforge.oss2.xml.event.Maskelement[] array = new com.netxforge.oss2.xml.event.Maskelement[0]; return (com.netxforge.oss2.xml.event.Maskelement[]) this._maskelementList.toArray(array); } /** * Method getMaskelementCollection.Returns a reference to * '_maskelementList'. No type checking is performed on any * modifications to the Vector. * * @return a reference to the Vector backing this class */ public java.util.List<com.netxforge.oss2.xml.event.Maskelement> getMaskelementCollection() { return this._maskelementList; } /** * Method getMaskelementCount. * * @return the size of this collection */ public int getMaskelementCount() { return this._maskelementList.size(); } /** * Method iterateMaskelement. * * @return an Iterator over all possible elements in this * collection */ public java.util.Iterator<com.netxforge.oss2.xml.event.Maskelement> iterateMaskelement() { return this._maskelementList.iterator(); } /** */ public void removeAllMaskelement() { this._maskelementList.clear(); } /** * Method removeMaskelement. * * @param vMaskelement * @return true if the object was removed from the collection. */ public boolean removeMaskelement(final com.netxforge.oss2.xml.event.Maskelement vMaskelement) { boolean removed = _maskelementList.remove(vMaskelement); return removed; } /** * Method removeMaskelementAt. * * @param index * @return the element removed from the collection */ public com.netxforge.oss2.xml.event.Maskelement removeMaskelementAt(final int index) { java.lang.Object obj = this._maskelementList.remove(index); return (com.netxforge.oss2.xml.event.Maskelement) obj; } /** * * * @param index * @param vMaskelement * @throws java.lang.IndexOutOfBoundsException if the index * given is outside the bounds of the collection */ public void setMaskelement(final int index, final com.netxforge.oss2.xml.event.Maskelement vMaskelement) throws java.lang.IndexOutOfBoundsException { // check bounds for index if (index < 0 || index >= this._maskelementList.size()) { throw new IndexOutOfBoundsException("setMaskelement: Index value '" + index + "' not in range [0.." + (this._maskelementList.size() - 1) + "]"); } this._maskelementList.set(index, vMaskelement); } /** * * * @param vMaskelementArray */ public void setMaskelement(final com.netxforge.oss2.xml.event.Maskelement[] vMaskelementArray) { //-- copy array _maskelementList.clear(); for (int i = 0; i < vMaskelementArray.length; i++) { this._maskelementList.add(vMaskelementArray[i]); } } /** * Sets the value of '_maskelementList' by copying the given * Vector. All elements will be checked for type safety. * * @param vMaskelementList the Vector to copy. */ public void setMaskelement(final java.util.List<com.netxforge.oss2.xml.event.Maskelement> vMaskelementList) { // copy vector this._maskelementList.clear(); this._maskelementList.addAll(vMaskelementList); } /** * Sets the value of '_maskelementList' by setting it to the * given Vector. No type checking is performed. * @deprecated * * @param maskelementList the Vector to set. */ public void setMaskelementCollection( final java.util.List<com.netxforge.oss2.xml.event.Maskelement> maskelementList) { this._maskelementList = maskelementList; } public String toString() { return new ToStringBuilder(this).append("maskelement", _maskelementList).toString(); } }