org.onosproject.yang.compiler.translator.tojava.javamodel

Class YangJavaSubModuleTranslator

java.lang.Object

org.onosproject.yang.compiler.datamodel.YangNode

org.onosproject.yang.compiler.datamodel.YangSubModule

org.onosproject.yang.compiler.datamodel.javadatamodel.YangJavaSubModule

org.onosproject.yang.compiler.translator.tojava.javamodel.YangJavaSubModuleTranslator

All Implemented Interfaces:

Serializable, Cloneable, Comparable<org.onosproject.yang.compiler.datamodel.YangNode>, org.onosproject.yang.compiler.datamodel.CollisionDetector, org.onosproject.yang.compiler.datamodel.LocationInfo, org.onosproject.yang.compiler.datamodel.RpcNotificationContainer, org.onosproject.yang.compiler.datamodel.utils.Parsable, org.onosproject.yang.compiler.datamodel.YangDesc, org.onosproject.yang.compiler.datamodel.YangDeviationHolder, org.onosproject.yang.compiler.datamodel.YangFeatureHolder, org.onosproject.yang.compiler.datamodel.YangIsFilterContentNodes, org.onosproject.yang.compiler.datamodel.YangLeavesHolder, org.onosproject.yang.compiler.datamodel.YangReference, org.onosproject.yang.compiler.datamodel.YangReferenceResolver, org.onosproject.yang.compiler.datamodel.YangSchemaNode, org.onosproject.yang.compiler.datamodel.YangVersionHolder, JavaCodeGenerator, JavaCodeGeneratorInfo, JavaFileInfoContainer, TempJavaCodeFragmentFilesContainer, org.onosproject.yang.model.SchemaContext, org.onosproject.yang.model.YangNamespace

public class YangJavaSubModuleTranslator
extends org.onosproject.yang.compiler.datamodel.javadatamodel.YangJavaSubModule
implements JavaCodeGeneratorInfo, JavaCodeGenerator

Represents sub module information extended to support java code generation.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.onosproject.yang.compiler.datamodel.javadatamodel.YangJavaSubModule

javaFileInfo, notificationNodes

Constructor Summary

Constructors

Constructor and Description
YangJavaSubModuleTranslator() Creates YANG java sub module object.

Method Summary

Modifier and Type	Method and Description
void	generateCodeEntry(org.onosproject.yang.compiler.utils.io.YangPluginConfig yangPlugin) Prepares the information for java code generation corresponding to YANG submodule info.
void	generateCodeExit() Creates a java file using the YANG submodule info.
JavaFileInfoTranslator	getJavaFileInfo() Returns the generated java file information.
String	getNameSpaceFromModule() Returns the name space of the module to which the sub module belongs to.
TempJavaCodeFragmentFiles	getTempJavaCodeFragmentFiles() Returns the temporary file handle.
void	setJavaFileInfo(JavaFileInfoTranslator javaInfo) Sets the java file info object.
void	setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) Sets temporary file handle.

Methods inherited from class org.onosproject.yang.compiler.datamodel.javadatamodel.YangJavaSubModule

getJavaAttributeName, getJavaClassNameOrBuiltInType, getJavaPackage, getNotificationNodes

Methods inherited from class org.onosproject.yang.compiler.datamodel.YangSubModule

addExtension, addFeatureList, addLeaf, addLeafList, addReferencesToImportList, addReferencesToIncludeList, addToAugmentList, addToChildSchemaMap, addToDefaultChildMap, addToIdentityTypedefMap, addToImportList, addToIncludeList, addToNotificationEnumMap, addToResolutionList, addToUniqueHolderList, detectCollidingChild, detectSelfCollision, getAugmentList, getBelongsTo, getContact, getDescription, getExtensionList, getFeatureList, getImportList, getIncludeList, getListOfLeaf, getListOfLeafList, getModuleName, getModuleNamespace, getNotificationSchemaNode, getOrganization, getPrefix, getReference, getRevision, getUniqueHolderList, getUnresolvedResolutionList, getVersion, getYangConstructType, getYangSchemaNodeType, incrementMandatoryChildCount, isDeviatedNodeCloned, isModuleForDeviation, isNotificationPresent, isRpcPresent, linkWithModule, removeLeaf, removeLeafList, resolveIdentityExtendList, resolveInterFileLinking, resolveSelfFileLinking, resolveUniqueLinking, setBelongsTo, setContact, setDescription, setDeviatedNodeCloned, setExtensionList, setImportList, setIncludeList, setLeafNameSpaceAndAddToParentSchemaMap, setLeafParentContext, setListOfFeature, setListOfLeaf, setListOfLeafList, setModuleForDeviation, setModuleNamespace, setNotificationPresenceFlag, setOrganization, setPrefix, setReference, setResolutionList, setRevision, setRpcPresent, setVersion, validateDataOnEntry, validateDataOnExit

Methods inherited from class org.onosproject.yang.compiler.datamodel.YangNode

addChild, addSchema, addToYsnContextInfoMap, clone, cloneGroupingTree, cloneSubTree, compareTo, getCharPosition, getChild, getChildSchema, getDefaultChild, getDefaultChildMap, getFileName, getLineNumber, getMandatoryChildCount, getName, getNameSpace, getNextSibling, getNodeType, getParent, getParentContext, getPreviousSibling, getPriority, getReferredSchema, getSchemaId, getType, getYangSchemaNodeIdentifier, getYsnContextInfoMap, isDescendantNodeAugmented, isEmptyDataType, isOpTypeReq, isToTranslate, isValueValid, processAdditionOfSchemaNodeToCurNodeMap, processAdditionOfSchemaNodeToParentMap, setCharPosition, setChild, setDescendantNodeAugmented, setFileName, setLeafRootContext, setLineNumber, setMandatoryChildCount, setName, setNameSpace, setNameSpaceAndAddToParentSchemaMap, setNextSibling, setParent, setParentContext, setParentContext, setPreviousSibling, setPriority, setRootContext, setToTranslate, setYangSchemaNodeIdentifier, setYsnContextInfoMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.yang.compiler.datamodel.LocationInfo

getCharPosition, getFileName, getLineNumber, setCharPosition, setFileName, setLineNumber

Constructor Detail

YangJavaSubModuleTranslator

public YangJavaSubModuleTranslator()

Creates YANG java sub module object.

Method Detail

getJavaFileInfo

public JavaFileInfoTranslator getJavaFileInfo()

Returns the generated java file information.

Specified by:

getJavaFileInfo in interface JavaFileInfoContainer

Overrides:

getJavaFileInfo in class org.onosproject.yang.compiler.datamodel.javadatamodel.YangJavaSubModule

Returns:

generated java file information

setJavaFileInfo

public void setJavaFileInfo(JavaFileInfoTranslator javaInfo)

Sets the java file info object.

Specified by:

setJavaFileInfo in interface JavaFileInfoContainer

Parameters:

javaInfo - java file info object

getTempJavaCodeFragmentFiles

public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles()

Returns the temporary file handle.

Specified by:

getTempJavaCodeFragmentFiles in interface TempJavaCodeFragmentFilesContainer

Returns:

temporary file handle

setTempJavaCodeFragmentFiles

public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle)

Sets temporary file handle.

Specified by:

setTempJavaCodeFragmentFiles in interface TempJavaCodeFragmentFilesContainer

Parameters:

fileHandle - temporary file handle

getNameSpaceFromModule

public String getNameSpaceFromModule()

Returns the name space of the module to which the sub module belongs to.

Returns:

the name space string of the module.

generateCodeEntry

public void generateCodeEntry(org.onosproject.yang.compiler.utils.io.YangPluginConfig yangPlugin)
                       throws TranslatorException

Prepares the information for java code generation corresponding to YANG submodule info.

Specified by:

generateCodeEntry in interface JavaCodeGenerator

Parameters:

yangPlugin - YANG plugin config

Throws:

TranslatorException - when fails to translate

generateCodeExit

public void generateCodeExit()
                      throws TranslatorException

Creates a java file using the YANG submodule info.

Specified by:

generateCodeExit in interface JavaCodeGenerator

Throws:

TranslatorException - when fails to generate java code