org.onosproject.yang.model

Class ResourceId.Builder

java.lang.Object

org.onosproject.yang.model.ResourceId.Builder

Enclosing class:

ResourceId

public static class ResourceId.Builder
extends Object

Builder to construct resource identifier.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	appInfo Application related information, this enables application to use this builder as there work bench.
protected NodeKey.NodeKeyBuilder	curKeyBuilder
protected List<NodeKey>	nodeKeyList

Constructor Summary

Constructors

Constructor and Description
Builder() Creates an instance of resource identifier builder.
Builder(ResourceId id) Creates an instance of resource identifier builder.

Method Summary

Modifier and Type	Method and Description
ResourceId.Builder	addBranchPointSchema(String name, String nameSpace) Adds the descendant node's schema identity.
ResourceId.Builder	addKeyLeaf(String name, String nameSpace, Object val) Adds a multi instance nodes key attribute value to identify the branch point of instance tree.
ResourceId.Builder	addLeafListBranchPoint(String name, String nameSpace, Object val) Adds a multi instance attribute's node identity.
ResourceId.Builder	append(List<NodeKey> nodeKeys) Appends a given list of NodeKey to current builder.
ResourceId.Builder	append(ResourceId id) Appends a given resource id to current builder.
Object	appInfo() Returns application information.
void	appInfo(Object appInfo) Sets application information.
ResourceId	build() Builds a resource identifier to based on set path information of the resource.
protected void	processCurKey() Validates, build and add current key.
ResourceId.Builder	removeLastKey() Removes last key in the node key list.

Methods inherited from class java.lang.Object

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

Field Detail

appInfo

protected Object appInfo

Application related information, this enables application to use this builder as there work bench.

nodeKeyList

protected List<NodeKey> nodeKeyList

curKeyBuilder

protected NodeKey.NodeKeyBuilder curKeyBuilder

Constructor Detail

Builder

public Builder()

Creates an instance of resource identifier builder.

Builder

public Builder(ResourceId id)
        throws CloneNotSupportedException

Creates an instance of resource identifier builder. This is used in scenario when builder is required from a given resource identifier.

Parameters:

id - old resource identifier

Throws:

CloneNotSupportedException - when clone is not supported

Method Detail

append

public ResourceId.Builder append(ResourceId id)
                          throws CloneNotSupportedException

Appends a given resource id to current builder.

Parameters:

id - resource identifier to be appended

Returns:

builder

Throws:

CloneNotSupportedException - when clone is not supported

append

public ResourceId.Builder append(List<NodeKey> nodeKeys)

Appends a given list of NodeKey to current builder.

Parameters:

nodeKeys - list of NodeKey to be appended

Returns:

builder

processCurKey

protected void processCurKey()

Validates, build and add current key.

addBranchPointSchema

public ResourceId.Builder addBranchPointSchema(String name,
                                               String nameSpace)

Adds the descendant node's schema identity.

Parameters:

name - name of descendant node

nameSpace - name space pf descendant node

Returns:

updated builder pointing to the specified schema location

addLeafListBranchPoint

public ResourceId.Builder addLeafListBranchPoint(String name,
                                                 String nameSpace,
                                                 Object val)

Adds a multi instance attribute's node identity.

Parameters:

name - name of the leaf list

nameSpace - name space of leaf list

val - value of attribute to identify the instance

Returns:

updated builder pointing to the specific attribute value instance

addKeyLeaf

public ResourceId.Builder addKeyLeaf(String name,
                                     String nameSpace,
                                     Object val)

Adds a multi instance nodes key attribute value to identify the branch point of instance tree.

Parameters:

name - name of the key attribute

nameSpace - name space of key attribute

val - value of the key leaf, to match in the list entry

Returns:

updated builder with list branching information

build

public ResourceId build()

Builds a resource identifier to based on set path information of the resource.

Returns:

built resource identifier

removeLastKey

public ResourceId.Builder removeLastKey()

Removes last key in the node key list.

Returns:

updated builder

appInfo

public Object appInfo()

Returns application information. This enables application to use this builder as there work bench.

Returns:

application information

appInfo

public void appInfo(Object appInfo)

Sets application information. This enables application to use this builder as there work bench.

Parameters:

appInfo - application related information