com.vhosting.netconf.frame
Interface Assignable


public interface Assignable

An element of the RPC structure that implements this interface can itself contain assignable elements.

Version:
1.00, 09/10/2010
Author:
Giuseppe Palmeri

Method Summary
 void assignAnyxml(Anyxml a, org.w3c.dom.Document e)
          Allows you to assign an XML document to an Anyxml element previously linked to this.
 void assignLeaf(Leaf l, java.lang.String canonicalValue)
          Allows you to assign a value to a leaf element previously linked to this.
 void assignLeafList(LeafList l, java.lang.String[] canonicalValues)
          Allows you to assign values to a leaf list element previously linked to this.
 java.util.List<Attribute> getAnyxmlAttributes(Anyxml a)
          Get the list of attributes of the specified Anyxml element previously linked to this.
 org.w3c.dom.Document getAnyxmlValue(Anyxml anyxml)
          Get the XML Document of the specified Anyxml element previously linked to this.
 java.util.List<Attribute> getLeafAttributes(Leaf l)
          Get the list of attributes of the specified leaf element previously linked to this.
 java.lang.String getLeafCanonicalValue(Leaf l)
          Get the value of the specified leaf element previously linked to this.
 java.util.List<Attribute>[] getLeafListAttributes(LeafList l)
          Get the lists of attributes of the specified leaf list element previously linked to this.
 java.lang.String[] getLeafListCanonicalValues(LeafList l)
          Get the values of the specified leaf list element previously linked to this.
 void unsetAnyxml(Anyxml a)
          Unset the XML document associated with the specified Anyxml element previously linked to this.
 void unsetLeaf(Leaf l)
          Unset the value associated with the specified leaf element previously linked to this.
 void unsetLeafList(LeafList l)
          Unset the values associated with the specified leaf list element previously linked to this.
 

Method Detail

assignLeaf

void assignLeaf(Leaf l,
                java.lang.String canonicalValue)
Allows you to assign a value to a leaf element previously linked to this. The value is the canonical value in a YANG context. See RFC6020

Parameters:
l - The leaf element.
canonicalValue - The value of the leaf.
See Also:
Node

assignLeafList

void assignLeafList(LeafList l,
                    java.lang.String[] canonicalValues)
Allows you to assign values to a leaf list element previously linked to this. The values are the canonical values in a YANG context. See RFC6020

Parameters:
l - The leaf list element.
canonicalValues - The values of the leaf list.
See Also:
Node

assignAnyxml

void assignAnyxml(Anyxml a,
                  org.w3c.dom.Document e)
Allows you to assign an XML document to an Anyxml element previously linked to this. The XML document should be made in advance through the method:
Anyxml.createEmptyDocument();
of an instance of the Anyxml element.

Parameters:
a - The Anyxml element.
e - The XML Document.
See Also:
Anyxml.createEmptyDocument()

getLeafCanonicalValue

java.lang.String getLeafCanonicalValue(Leaf l)
Get the value of the specified leaf element previously linked to this. The value is the canonical value in a YANG context. See RFC6020

Parameters:
l - The leaf element.
Returns:
The value of the leaf element or null if not exists.

getLeafListCanonicalValues

java.lang.String[] getLeafListCanonicalValues(LeafList l)
Get the values of the specified leaf list element previously linked to this. The values are the canonical values in a YANG context. See RFC6020

Parameters:
l - The leaf list element.
Returns:
The values of the leaf list element or an empty array if not exist.

getAnyxmlValue

org.w3c.dom.Document getAnyxmlValue(Anyxml anyxml)
Get the XML Document of the specified Anyxml element previously linked to this.

Parameters:
anyxml - The Anyxml element.
Returns:
The XML document of the Anyxml element or null if not exists.

unsetLeaf

void unsetLeaf(Leaf l)
Unset the value associated with the specified leaf element previously linked to this. If no value was previously assigned to the element, the method does not perform any action.

Parameters:
l - The leaf element.

unsetLeafList

void unsetLeafList(LeafList l)
Unset the values associated with the specified leaf list element previously linked to this. If no values was previously assigned to the element, the method does not perform any action.

Parameters:
l - The leaf list element.

unsetAnyxml

void unsetAnyxml(Anyxml a)
Unset the XML document associated with the specified Anyxml element previously linked to this.

Parameters:
a - The Anyxml element.

getLeafAttributes

java.util.List<Attribute> getLeafAttributes(Leaf l)
Get the list of attributes of the specified leaf element previously linked to this. The list can be populated with new attributes.

Parameters:
l - The leaf element.
Returns:
The list of attributes.

getLeafListAttributes

java.util.List<Attribute>[] getLeafListAttributes(LeafList l)
Get the lists of attributes of the specified leaf list element previously linked to this. Each list contained in the array refers to the corresponding value assigned to the leaf list. The lists can be populated with new attributes.

Parameters:
l - The leaf list element.
Returns:
The array of lists of attributes.

getAnyxmlAttributes

java.util.List<Attribute> getAnyxmlAttributes(Anyxml a)
Get the list of attributes of the specified Anyxml element previously linked to this. The list can be populated with new attributes.

Parameters:
a - The Anyxml element.
Returns:
The list of attributes.