org.opendaylight.yangtools.yang.parser.builder.api

Interface TypeDefinitionBuilder

All Superinterfaces:

Builder, DocumentedNodeBuilder, GroupingMember, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>, SchemaNodeBuilder, TypeAwareBuilder

All Known Implementing Classes:

IdentityrefTypeBuilder, TypeDefinitionBuilderImpl, UnionTypeBuilder

public interface TypeDefinitionBuilder
extends TypeAwareBuilder, SchemaNodeBuilder, GroupingMember

Interface for builders of 'typedef' statement.

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.yangtools.yang.model.api.TypeDefinition<?>	build() Build YANG data model node.
Object	getDefaultValue() Returns default value of resulting type
Integer	getFractionDigits() Returns fractions digits of resulting type if it is derived from decimal built-in type.
List<org.opendaylight.yangtools.yang.model.api.type.LengthConstraint>	getLengths() Returns length restrictions of resulting type definition.
List<org.opendaylight.yangtools.yang.model.api.type.PatternConstraint>	getPatterns() Returns pattern restrictions of resulting type definition.
List<org.opendaylight.yangtools.yang.model.api.type.RangeConstraint>	getRanges() Returns range restrictions of resulting type definition.
String	getUnits() Gets unit definition for resulting type
void	setDefaultValue(Object defaultValue) Sets default value of resulting type
void	setFractionDigits(Integer fractionDigits) Sets fractions digits of resulting type if it is derived from decimal built-in type.
void	setLengths(List<org.opendaylight.yangtools.yang.model.api.type.LengthConstraint> lengths) Set length restrictions for resulting type definition.
void	setPatterns(List<org.opendaylight.yangtools.yang.model.api.type.PatternConstraint> patterns) Set pattern restrictions for resulting type definition.
void	setQName(org.opendaylight.yangtools.yang.common.QName qname) Sets QName for resulting type definition.
void	setRanges(List<org.opendaylight.yangtools.yang.model.api.type.RangeConstraint> ranges) Set Range restrictions for resulting type definition.
void	setUnits(String units) Sets units definition for resulting type

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder

getPath, getQName, getType, getTypedef, getTypeQName, setType, setTypedef, setTypeQName

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder

getPath, getQName, setPath

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.DocumentedNodeBuilder

getDescription, getReference, getStatus, setDescription, setReference, setStatus

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.GroupingMember

isAddedByUses, setAddedByUses

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.Builder

addUnknownNodeBuilder, getLine, getModuleName, getParent, getUnknownNodes, setModuleName, setParent

Method Detail

setQName

void setQName(org.opendaylight.yangtools.yang.common.QName qname)

Sets QName for resulting type definition.

Parameters:

qname - QName of resulting type

build

org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> build()

Description copied from interface: Builder

Build YANG data model node. This method should create an instance of YANG data model node. After creating an instance, this instance should be returned for each call without repeating build process.

Specified by:

build in interface Builder

Specified by:

build in interface SchemaNodeBuilder

Returns:

YANG data model node

getRanges

List<org.opendaylight.yangtools.yang.model.api.type.RangeConstraint> getRanges()

Returns range restrictions of resulting type definition.

Returns:

range restrictions of resulting type definition.

setRanges

void setRanges(List<org.opendaylight.yangtools.yang.model.api.type.RangeConstraint> ranges)

Set Range restrictions for resulting type definition.

Parameters:

ranges - Range restrictions of resulting type definition.

getLengths

List<org.opendaylight.yangtools.yang.model.api.type.LengthConstraint> getLengths()

Returns length restrictions of resulting type definition.

Returns:

length restrictions of resulting type definition.

setLengths

void setLengths(List<org.opendaylight.yangtools.yang.model.api.type.LengthConstraint> lengths)

Set length restrictions for resulting type definition.

Parameters:

lengths - Length restrictions of resulting type definition.

getPatterns

List<org.opendaylight.yangtools.yang.model.api.type.PatternConstraint> getPatterns()

Returns pattern restrictions of resulting type definition.

Returns:

range restrictions of resulting type definition.

setPatterns

void setPatterns(List<org.opendaylight.yangtools.yang.model.api.type.PatternConstraint> patterns)

Set pattern restrictions for resulting type definition.

Parameters:

patterns - patterns restrictions of resulting type definition.

getFractionDigits

Integer getFractionDigits()

Returns fractions digits of resulting type if it is derived from decimal built-in type.

Returns:

fractions digits of resulting type

setFractionDigits

void setFractionDigits(Integer fractionDigits)

Sets fractions digits of resulting type if it is derived from decimal built-in type.

getDefaultValue

Object getDefaultValue()

Returns default value of resulting type

Returns:

default value of resulting type

setDefaultValue

void setDefaultValue(Object defaultValue)

Sets default value of resulting type

Parameters:

defaultValue - Default value of resulting type

getUnits

String getUnits()

Gets unit definition for resulting type

Returns:

unit definition for resulting type

setUnits

void setUnits(String units)

Sets units definition for resulting type

Parameters:

units - units definition for resulting type