org.opennms.netmgt.config.capsd

Class SmbConfig

java.lang.Object

org.opennms.netmgt.config.capsd.SmbConfig

All Implemented Interfaces:

Serializable

public class SmbConfig
extends Object
implements Serializable

SMB configuration

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SmbConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSmbAuth(int index, SmbAuth vSmbAuth)
void	addSmbAuth(SmbAuth vSmbAuth)
Enumeration<SmbAuth>	enumerateSmbAuth() Method enumerateSmbAuth.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
SmbAuth[]	getSmbAuth() Method getSmbAuth.Returns the contents of the collection in an Array.
SmbAuth	getSmbAuth(int index) Method getSmbAuth.
List<SmbAuth>	getSmbAuthCollection() Method getSmbAuthCollection.Returns a reference to '_smbAuthList'.
int	getSmbAuthCount() Method getSmbAuthCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<SmbAuth>	iterateSmbAuth() Method iterateSmbAuth.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSmbAuth()
boolean	removeSmbAuth(SmbAuth vSmbAuth) Method removeSmbAuth.
SmbAuth	removeSmbAuthAt(int index) Method removeSmbAuthAt.
void	setSmbAuth(int index, SmbAuth vSmbAuth)
void	setSmbAuth(List<SmbAuth> vSmbAuthList) Sets the value of '_smbAuthList' by copying the given Vector.
void	setSmbAuth(SmbAuth[] vSmbAuthArray)
void	setSmbAuthCollection(List<SmbAuth> smbAuthList) Deprecated.
static SmbConfig	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

SmbConfig

public SmbConfig()

Method Detail

addSmbAuth

public void addSmbAuth(SmbAuth vSmbAuth)
                throws IndexOutOfBoundsException

Parameters:

vSmbAuth -

Throws:

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

addSmbAuth

public void addSmbAuth(int index,
              SmbAuth vSmbAuth)
                throws IndexOutOfBoundsException

Parameters:

index -

vSmbAuth -

Throws:

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

enumerateSmbAuth

public Enumeration<SmbAuth> enumerateSmbAuth()

Method enumerateSmbAuth.

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.

getSmbAuth

public SmbAuth getSmbAuth(int index)
                   throws IndexOutOfBoundsException

Method getSmbAuth.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.capsd.SmbAuth at the given index

Throws:

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

getSmbAuth

public SmbAuth[] getSmbAuth()

Method getSmbAuth.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

getSmbAuthCollection

public List<SmbAuth> getSmbAuthCollection()

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

Returns:

a reference to the Vector backing this class

getSmbAuthCount

public int getSmbAuthCount()

Method getSmbAuthCount.

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

iterateSmbAuth

public Iterator<SmbAuth> iterateSmbAuth()

Method iterateSmbAuth.

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

removeAllSmbAuth

public void removeAllSmbAuth()

removeSmbAuth

public boolean removeSmbAuth(SmbAuth vSmbAuth)

Method removeSmbAuth.

Parameters:

vSmbAuth -

Returns:

true if the object was removed from the collection.

removeSmbAuthAt

public SmbAuth removeSmbAuthAt(int index)

Method removeSmbAuthAt.

Parameters:

index -

Returns:

the element removed from the collection

setSmbAuth

public void setSmbAuth(int index,
              SmbAuth vSmbAuth)
                throws IndexOutOfBoundsException

Parameters:

index -

vSmbAuth -

Throws:

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

setSmbAuth

public void setSmbAuth(SmbAuth[] vSmbAuthArray)

Parameters:

vSmbAuthArray -

setSmbAuth

public void setSmbAuth(List<SmbAuth> vSmbAuthList)

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

Parameters:

vSmbAuthList - the Vector to copy.

setSmbAuthCollection

public void setSmbAuthCollection(List<SmbAuth> smbAuthList)

Deprecated.

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

Parameters:

smbAuthList - the Vector to set.

unmarshal

public static SmbConfig 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.capsd.SmbConfig

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