Package com.tailf.conf

Class ConfObjectRef

Object

com.tailf.conf.ConfObject

com.tailf.conf.ConfValue

com.tailf.conf.ConfObjectRef

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ConfObjectRef>

public class ConfObjectRef
extends ConfValue
implements Cloneable, Serializable, Comparable<ConfObjectRef>

Corresponds to the YANG instance-identifier type

    The following are examples of instance identifiers:

        // instance-identifier for a container
         /ex:system/ex:services/ex:ssh

        // instance-identifier for a leaf
         /ex:system/ex:services/ex:ssh/ex:port

       // instance-identifier for a list entry
        /ex:system/ex:user[ex:name='fred']

        // instance-identifier for a leaf in a list entry
     /ex:system/ex:user[ex:name='fred']/ex:type

        // instance-identifier for a list entry with two keys
     /ex:system/server[ip='192.0.2.1'][port='80']/system/
       server[ip='192.0.2.1' ex:port='80']

   // instance-identifier for a leaf-list entry
      /ex:system/ex:services/ex:ssh/ex:cipher[.='blowfish-cbc']

      // instance-identifier for a list entry without keys
       /ex:stats/ex:port[3]

       // instance-identifier for a leaf-list entry
      /ex:system/ex:services/ex:ssh/ex:cipher[.='blowfish-cbc']

 

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	Description
ConfObjectRef(ConfObject[] elems)	Constructor using the autoloaded namespaces.
ConfObjectRef(ConfPath path)	Construct a ConfObjectRef from a given Absolute ConfPath.
ConfObjectRef(ConfEObject o)	It assumes that param is of type ConfEList.
ConfObjectRef(String xpath)
ConfObjectRef(String xpath, MountIdInterface mountGetter)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ConfObjectRef o)
ConfEObject	encode()	encode value.
boolean	equals(Object o)	Determine if two ConfValue are equal.
ConfObject[]	getElems()
int	hashCode()
String	toString()

Methods inherited from class com.tailf.conf.ConfValue

getStringByValue, getStringByValue, getValueByString, getValueByString

Methods inherited from class com.tailf.conf.ConfObject

clone, decode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConfObjectRef

public ConfObjectRef(ConfObject[] elems)

Constructor using the autoloaded namespaces. It assumes that schemas have been loaded using Maapi.loadschermas().

Parameters:

elems -

ConfObjectRef

public ConfObjectRef(ConfEObject o)
              throws ConfException

It assumes that param is of type ConfEList.

Parameters:

o - is a ConfEList

Throws:

ConfException

ConfObjectRef

public ConfObjectRef(String xpath)
              throws ConfException

Throws:

ConfException

ConfObjectRef

public ConfObjectRef(String xpath,
 MountIdInterface mountGetter)
              throws ConfException

Throws:

ConfException

ConfObjectRef

public ConfObjectRef(ConfPath path)
              throws ConfException

Construct a ConfObjectRef from a given Absolute ConfPath.

Parameters:

path -

Throws:

ConfException - if the given path is relative.

Method Details

equals

public boolean equals(Object o)

Description copied from class: ConfValue

Determine if two ConfValue are equal. In general, ConfObjects are equal if the components they consist of are equal.

Specified by:

equals in class ConfValue

Parameters:

o - The object to compare to.

Returns:

true if the objects are identical.

hashCode

public int hashCode()

Specified by:

hashCode in class ConfValue

getElems

public ConfObject[] getElems()

toString

public String toString()

Specified by:

toString in class ConfValue

Returns:

the printable representation of the object.

encode

public ConfEObject encode()

Description copied from class: ConfValue

encode value.

Specified by:

encode in class ConfValue

compareTo

public int compareTo(ConfObjectRef o)

Specified by:

compareTo in interface Comparable<ConfObjectRef>