com.tailf.conf

Class ConfKey

Object

com.tailf.conf.ConfObject

com.tailf.conf.ConfKey

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ConfXKey

public class ConfKey
extends ConfObject
implements Cloneable, Serializable

This class represents a list key or a leaf-list element. A list key can consist of one or more values.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.tailf.conf.ConfObject

J_BINARY, J_BIT32, J_BIT64, J_BITBIG, J_BOOL, J_BUF, J_CDBBEGIN, J_DATE, J_DATETIME, J_DECIMAL64, J_DEFAULT, J_DOUBLE, J_DQUAD, J_DURATION, J_ENUMERATION, J_HEXSTR, J_IDENTITYREF, J_INSTANCE_IDENTIFIER, J_INT16, J_INT32, J_INT64, J_INT8, J_IPV4, J_IPV4_AND_PLEN, J_IPV4PREFIX, J_IPV6, J_IPV6_AND_PLEN, J_IPV6PREFIX, J_LIST, J_NOEXISTS, J_OBJECTREF, J_OID, J_PTR, J_QNAME, J_STR, J_SYMBOL, J_TIME, J_UINT16, J_UINT32, J_UINT64, J_UINT8, J_UNION, J_XMLBEGIN, J_XMLBEGINDEL, J_XMLEND, J_XMLMOVEAFTER, J_XMLMOVEFIRST, J_XMLTAG

Constructor Summary

Constructors

Constructor and Description
ConfKey(ConfEObject o)
ConfKey(ConfObject o)
ConfKey(ConfObject[] l)

Method Summary

Modifier and Type	Method and Description
ConfObject	elementAt(int i)
ConfObject[]	elements()
ConfEObject	encode()
boolean	equals(Object o) Indicates whether a ConfKey is "equal to" this.
int	hashCode()
int	length()
void	setPath(InstancePath path) This method is only useful if at least one of the key elements is an enumeration.
String	toStrictlyQuotedString() Returns a string representation of the ConfKey.
String	toString() Returns a string representation of the ConfKey.

Methods inherited from class com.tailf.conf.ConfObject

clone, decode

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfKey

public ConfKey(ConfObject o)

ConfKey

public ConfKey(ConfObject[] l)

ConfKey

public ConfKey(ConfEObject o)
        throws ConfException

Throws:

ConfException

Method Detail

elementAt

public ConfObject elementAt(int i)

elements

public ConfObject[] elements()

length

public int length()

equals

public boolean equals(Object o)

Indicates whether a ConfKey is "equal to" this.

A ConfKey is equals this if its components are equals.

Specified by:

equals in class ConfObject

Parameters:

o - the reference ConfKey with which to compare.

Returns:

true if this ConfKey is the same as the o argument; false otherwise.

hashCode

public int hashCode()

Specified by:

hashCode in class ConfObject

toStrictlyQuotedString

public String toStrictlyQuotedString()

Returns a string representation of the ConfKey. The key elements will be quoted if necessary.

Returns:

String representation of the key

toString

public String toString()

Returns a string representation of the ConfKey. The key elements will be quoted if necessary. Note however that this string representation is available for backward compatibility and is unsuitable for use in keypaths. Instead use ConfKey.toStrictlyQuotedString().

Specified by:

toString in class ConfObject

Returns:

String representation of the key

encode

public ConfEObject encode()

Specified by:

encode in class ConfObject

setPath

public void setPath(InstancePath path)

This method is only useful if at least one of the key elements is an enumeration. In such case this method will assign the MaapiSchemas type to all such elements to be able to get a correct label when converting the key into its String representation. The path provided as an argument needs to point to the list node in the data model.