org.opennms.netmgt.config.linkd

Class Vlans

java.lang.Object

org.opennms.netmgt.config.linkd.Vlans

All Implemented Interfaces:

Serializable

public class Vlans
extends Object
implements Serializable

Class Vlans.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Vlans()

Method Summary

Modifier and Type	Method and Description
void	addVendor(int index, Vendor vVendor)
void	addVendor(Vendor vVendor)
Enumeration<Vendor>	enumerateVendor() Method enumerateVendor.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Vendor[]	getVendor() Method getVendor.Returns the contents of the collection in an Array.
Vendor	getVendor(int index) Method getVendor.
List<Vendor>	getVendorCollection() Method getVendorCollection.Returns a reference to '_vendorList'.
int	getVendorCount() Method getVendorCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Vendor>	iterateVendor() Method iterateVendor.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllVendor()
boolean	removeVendor(Vendor vVendor) Method removeVendor.
Vendor	removeVendorAt(int index) Method removeVendorAt.
void	setVendor(int index, Vendor vVendor)
void	setVendor(List<Vendor> vVendorList) Sets the value of '_vendorList' by copying the given Vector.
void	setVendor(Vendor[] vVendorArray)
void	setVendorCollection(List<Vendor> vendorList) Deprecated.
static Vlans	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Vlans

public Vlans()

Method Detail

addVendor

public void addVendor(Vendor vVendor)
               throws IndexOutOfBoundsException

Parameters:

vVendor -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addVendor

public void addVendor(int index,
                      Vendor vVendor)
               throws IndexOutOfBoundsException

Parameters:

index -

vVendor -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateVendor

public Enumeration<Vendor> enumerateVendor()

Method enumerateVendor.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getVendor

public Vendor getVendor(int index)
                 throws IndexOutOfBoundsException

Method getVendor.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.linkd.Vendor at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getVendor

public Vendor[] getVendor()

Method getVendor.Returns the contents of the collection in an Array.

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 know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getVendorCollection

public List<Vendor> getVendorCollection()

Method getVendorCollection.Returns a reference to '_vendorList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getVendorCount

public int getVendorCount()

Method getVendorCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateVendor

public Iterator<Vendor> iterateVendor()

Method iterateVendor.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllVendor

public void removeAllVendor()

removeVendor

public boolean removeVendor(Vendor vVendor)

Method removeVendor.

Parameters:

vVendor -

Returns:

true if the object was removed from the collection.

removeVendorAt

public Vendor removeVendorAt(int index)

Method removeVendorAt.

Parameters:

index -

Returns:

the element removed from the collection

setVendor

public void setVendor(int index,
                      Vendor vVendor)
               throws IndexOutOfBoundsException

Parameters:

index -

vVendor -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setVendor

public void setVendor(Vendor[] vVendorArray)

Parameters:

vVendorArray -

setVendor

public void setVendor(List<Vendor> vVendorList)

Sets the value of '_vendorList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vVendorList - the Vector to copy.

setVendorCollection

public void setVendorCollection(List<Vendor> vendorList)

Deprecated.

Sets the value of '_vendorList' by setting it to the given Vector. No type checking is performed.

Parameters:

vendorList - the Vector to set.

unmarshal

public static Vlans unmarshal(Reader reader)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.linkd.Vlans

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema