org.onosproject.yang.compiler.translator.tojava

Class TempJavaFragmentFiles

java.lang.Object

org.onosproject.yang.compiler.translator.tojava.TempJavaFragmentFiles

Direct Known Subclasses:

TempJavaBeanFragmentFiles, TempJavaEnumerationFragmentFiles, TempJavaEventFragmentFiles, TempJavaRpcCommandFragmentFiles, TempJavaRpcFragmentFiles, TempJavaServiceFragmentFiles, TempJavaTypeFragmentFiles

public class TempJavaFragmentFiles
extends Object

Represents implementation of java code fragments temporary implementations. Manages the common temp file required for Java file(s) generated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TempJavaFragmentFiles(JavaFileInfoTranslator fileInfo) Creates an instance of temporary java code fragment.

Method Summary

Modifier and Type	Method and Description
protected static void	addCurNodeInfoInParentTempFile(org.onosproject.yang.compiler.datamodel.YangNode curNode, boolean isList, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Adds current node info as and attribute to the parent generated file.
protected static void	addCurNodeInfoInParentTempFile(org.onosproject.yang.compiler.datamodel.YangNode curNode, boolean isList, org.onosproject.yang.compiler.utils.io.YangPluginConfig config, org.onosproject.yang.compiler.datamodel.YangNode parent) Adds current node info as and attribute to a specified parent generated file.
protected void	addCurNodeLeavesInfoToTempFiles(org.onosproject.yang.compiler.datamodel.YangNode curNode, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Adds all the leaves in the current data model node as part of the generated temporary file.
protected String	addDefaultConstructor(String modifier, String toAppend, boolean suffix) Adds default constructor for class.
protected void	addGeneratedTempFile(int flags) Adds to the flag-set for generated temp files.
protected void	addGetterImpl(JavaAttributeInfo attr) Adds getter method's impl for class.
protected void	addParentInfoInCurNodeTempFile(org.onosproject.yang.compiler.datamodel.YangNode curNode, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Adds parent's info to current node import list.
protected void	addValueLeafFlag(org.onosproject.yang.compiler.utils.io.YangPluginConfig config, org.onosproject.yang.compiler.datamodel.YangNode node) Adds value leaf flag to temp files.
protected void	appendToFile(File file, String data) Appends content to temporary file.
void	freeTemporaryResources(boolean errorOccurred) Removes all temporary file handles.
void	generateJavaFile(int fileType, org.onosproject.yang.compiler.datamodel.YangNode curNode) Constructs java code exit.
File	getAddToListImplTempFileHandle() Returns temp file handle for add to list impl.
File	getAddToListInterfaceTempFileHandle() Returns temp file handle for add to list interface.
File	getAttributesTempFileHandle() Returns attribute's temporary file handle.
static JavaAttributeInfo	getCurNodeAsAttributeInTarget(org.onosproject.yang.compiler.datamodel.YangNode curNode, org.onosproject.yang.compiler.datamodel.YangNode targetNode, boolean listNode, TempJavaFragmentFiles tempFiles) Creates an attribute info object corresponding to a data model node and return it.
File	getEditContentTempFileHandle() Returns temp file for edit content file.
File	getEqualsImplTempFileHandle() Returns equals method's temporary file handle.
File	getFromStringImplTempFileHandle() Returns from string method's temporary file handle.
protected String	getGeneratedJavaClassName() Retrieves the mapped Java class name.
protected int	getGeneratedJavaFiles() Returns the generated Java files.
protected int	getGeneratedTempFiles() Returns the flag-set for generated temp files.
File	getGetterImplTempFileHandle() Returns getter method's impl's temporary file handle.
File	getGetterInterfaceTempFileHandle() Returns getter methods's temporary file handle.
File	getHashCodeImplTempFileHandle() Returns hash code method's temporary file handle.
protected boolean	getIsQualifiedAccessOrAddToImportList(org.onosproject.yang.compiler.datamodel.javadatamodel.JavaQualifiedTypeInfo importInfo) Returns if the attribute needs to be accessed in a qualified manner or not, if it needs to be imported, then the same needs to be done.
protected String	getJavaClassName(String suffix) Returns JAVA class name for non implementation classes.
JavaExtendsListHolder	getJavaExtendsListHolder() Returns java extends list holder.
File	getJavaFileHandle(String fileName) Returns a temporary file handle for the specific file type.
protected JavaFileInfoTranslator	getJavaFileInfo() Returns the generated java file information.
JavaImportData	getJavaImportData() Retrieves the import data for the generated Java file.
File	getLeafIdAttributeTempFileHandle() Returns temp file handle for leaf identifier attributes.
static List<JavaAttributeInfo>	getListOfAttributesForKey(org.onosproject.yang.compiler.datamodel.YangNode curNode) Returns list of java attribute for keys of list node.
File	getSetterImplTempFileHandle() Returns setter method's impl's temporary file handle.
File	getSetterInterfaceTempFileHandle() Returns setter method's temporary file handle.
String	getTemporaryDataFromFileHandle(File file, String absolutePath) Returns data from the temporary files.
protected File	getTemporaryFileHandle(String fileName) Returns a temporary file handle for the specific file type.
File	getToStringImplTempFileHandle() Returns to string method's temporary file handle.
protected boolean	isAttributePresent() Retrieves the status of any attributes added.
protected String	parseAttribute(JavaAttributeInfo attr) Parses attribute to get the attribute string.
protected void	setAbsoluteDirPath(String absoluteDirPath) Sets absolute path where the file needs to be generated.
void	setAttrNode(org.onosproject.yang.compiler.datamodel.YangNode attrNode) Sets attribute's node.
protected void	setJavaExtendsListHolder(JavaExtendsListHolder holder) Sets java extends list holder.
protected void	setJavaFileInfo(JavaFileInfoTranslator javaFileInfo) Sets the generated java file information.
protected void	setJavaImportData(JavaImportData data) Sets import data for the generated Java file.

Methods inherited from class java.lang.Object

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

Constructor Detail

TempJavaFragmentFiles

protected TempJavaFragmentFiles(JavaFileInfoTranslator fileInfo)
                         throws IOException

Creates an instance of temporary java code fragment.

Parameters:

fileInfo - generated java file information

Throws:

IOException - when fails to create new file handle

Method Detail

addCurNodeInfoInParentTempFile

protected static void addCurNodeInfoInParentTempFile(org.onosproject.yang.compiler.datamodel.YangNode curNode,
                                                     boolean isList,
                                                     org.onosproject.yang.compiler.utils.io.YangPluginConfig config)
                                              throws IOException

Adds current node info as and attribute to the parent generated file.

Parameters:

curNode - current node

isList - is list construct

config - plugin configurations

Throws:

IOException - IO operation exception

addCurNodeInfoInParentTempFile

protected static void addCurNodeInfoInParentTempFile(org.onosproject.yang.compiler.datamodel.YangNode curNode,
                                                     boolean isList,
                                                     org.onosproject.yang.compiler.utils.io.YangPluginConfig config,
                                                     org.onosproject.yang.compiler.datamodel.YangNode parent)
                                              throws IOException

Adds current node info as and attribute to a specified parent generated file. In case of grouping parent will be referred grouping node or referred node in grouping.

Parameters:

curNode - current node

isList - is list construct

config - plugin configurations

parent - parent node

Throws:

IOException - IO operation exception

getCurNodeAsAttributeInTarget

public static JavaAttributeInfo getCurNodeAsAttributeInTarget(org.onosproject.yang.compiler.datamodel.YangNode curNode,
                                                              org.onosproject.yang.compiler.datamodel.YangNode targetNode,
                                                              boolean listNode,
                                                              TempJavaFragmentFiles tempFiles)

Creates an attribute info object corresponding to a data model node and return it.

Parameters:

curNode - current node

targetNode - target node

listNode - flag indicating if a node is a list node

tempFiles - temp java fragment files

Returns:

java attribute info

getListOfAttributesForKey

public static List<JavaAttributeInfo> getListOfAttributesForKey(org.onosproject.yang.compiler.datamodel.YangNode curNode)
                                                         throws IOException

Returns list of java attribute for keys of list node.

Parameters:

curNode - current list node

Returns:

attribute list

Throws:

IOException - when fails to do IO operations

setAbsoluteDirPath

protected void setAbsoluteDirPath(String absoluteDirPath)

Sets absolute path where the file needs to be generated.

Parameters:

absoluteDirPath - absolute path where the file needs to be generated

getJavaFileInfo

protected JavaFileInfoTranslator getJavaFileInfo()

Returns the generated java file information.

Returns:

generated java file information

setJavaFileInfo

protected void setJavaFileInfo(JavaFileInfoTranslator javaFileInfo)

Sets the generated java file information.

Parameters:

javaFileInfo - generated java file information

getGeneratedTempFiles

protected int getGeneratedTempFiles()

Returns the flag-set for generated temp files.

Returns:

flag-set

addGeneratedTempFile

protected void addGeneratedTempFile(int flags)

Adds to the flag-set for generated temp files.

Parameters:

flags - generated temp files flag-set

getGeneratedJavaFiles

protected int getGeneratedJavaFiles()

Returns the generated Java files.

Returns:

generated Java files

getGeneratedJavaClassName

protected String getGeneratedJavaClassName()

Retrieves the mapped Java class name.

Returns:

mapped Java class name

getJavaImportData

public JavaImportData getJavaImportData()

Retrieves the import data for the generated Java file.

Returns:

import data for the generated Java file

setJavaImportData

protected void setJavaImportData(JavaImportData data)

Sets import data for the generated Java file.

Parameters:

data - import data for the generated Java file

isAttributePresent

protected boolean isAttributePresent()

Retrieves the status of any attributes added.

Returns:

status of any attributes added

getGetterInterfaceTempFileHandle

public File getGetterInterfaceTempFileHandle()

Returns getter methods's temporary file handle.

Returns:

temporary file handle

getSetterInterfaceTempFileHandle

public File getSetterInterfaceTempFileHandle()

Returns setter method's temporary file handle.

Returns:

temporary file handle

getSetterImplTempFileHandle

public File getSetterImplTempFileHandle()

Returns setter method's impl's temporary file handle.

Returns:

temporary file handle

getFromStringImplTempFileHandle

public File getFromStringImplTempFileHandle()

Returns from string method's temporary file handle.

Returns:

from string method's temporary file handle

getAttributesTempFileHandle

public File getAttributesTempFileHandle()

Returns attribute's temporary file handle.

Returns:

temporary file handle

getGetterImplTempFileHandle

public File getGetterImplTempFileHandle()

Returns getter method's impl's temporary file handle.

Returns:

temporary file handle

getHashCodeImplTempFileHandle

public File getHashCodeImplTempFileHandle()

Returns hash code method's temporary file handle.

Returns:

temporary file handle

getEqualsImplTempFileHandle

public File getEqualsImplTempFileHandle()

Returns equals method's temporary file handle.

Returns:

temporary file handle

getToStringImplTempFileHandle

public File getToStringImplTempFileHandle()

Returns to string method's temporary file handle.

Returns:

temporary file handle

getJavaExtendsListHolder

public JavaExtendsListHolder getJavaExtendsListHolder()

Returns java extends list holder.

Returns:

java extends list holder

setJavaExtendsListHolder

protected void setJavaExtendsListHolder(JavaExtendsListHolder holder)

Sets java extends list holder.

Parameters:

holder - java extends list holder

addGetterImpl

protected void addGetterImpl(JavaAttributeInfo attr)
                      throws IOException

Adds getter method's impl for class.

Parameters:

attr - attribute info

Throws:

IOException - when fails to append to temporary file

addDefaultConstructor

protected String addDefaultConstructor(String modifier,
                                       String toAppend,
                                       boolean suffix)
                                throws IOException

Adds default constructor for class.

Parameters:

modifier - modifier for constructor

toAppend - string which need to be appended with the class name

suffix - is value need to be appended as suffix

Returns:

default constructor for class

Throws:

IOException - when fails to append to file

getTemporaryFileHandle

protected File getTemporaryFileHandle(String fileName)
                               throws IOException

Returns a temporary file handle for the specific file type.

Parameters:

fileName - file name

Returns:

temporary file handle

Throws:

IOException - when fails to create new file handle

getJavaFileHandle

public File getJavaFileHandle(String fileName)
                       throws IOException

Returns a temporary file handle for the specific file type.

Parameters:

fileName - file name

Returns:

temporary file handle

Throws:

IOException - when fails to create new file handle

getTemporaryDataFromFileHandle

public String getTemporaryDataFromFileHandle(File file,
                                             String absolutePath)
                                      throws IOException

Returns data from the temporary files.

Parameters:

file - temporary file handle

absolutePath - absolute path

Returns:

stored data from temporary files

Throws:

IOException - when failed to get data from the given file

parseAttribute

protected String parseAttribute(JavaAttributeInfo attr)

Parses attribute to get the attribute string.

Parameters:

attr - attribute info

Returns:

attribute string

appendToFile

protected void appendToFile(File file,
                            String data)
                     throws IOException

Appends content to temporary file.

Parameters:

file - temporary file

data - data to be appended

Throws:

IOException - when fails to append to file

addParentInfoInCurNodeTempFile

protected void addParentInfoInCurNodeTempFile(org.onosproject.yang.compiler.datamodel.YangNode curNode,
                                              org.onosproject.yang.compiler.utils.io.YangPluginConfig config)

Adds parent's info to current node import list.

Parameters:

curNode - current node

config - plugin configurations

addCurNodeLeavesInfoToTempFiles

protected void addCurNodeLeavesInfoToTempFiles(org.onosproject.yang.compiler.datamodel.YangNode curNode,
                                               org.onosproject.yang.compiler.utils.io.YangPluginConfig config)
                                        throws IOException

Adds all the leaves in the current data model node as part of the generated temporary file.

Parameters:

curNode - current node

config - plugin config

Throws:

IOException - IO operation fail

addValueLeafFlag

protected void addValueLeafFlag(org.onosproject.yang.compiler.utils.io.YangPluginConfig config,
                                org.onosproject.yang.compiler.datamodel.YangNode node)
                         throws IOException

Adds value leaf flag to temp files.

Parameters:

config - YANG plugin config

node - YANG node

Throws:

IOException - IO exception

getJavaClassName

protected String getJavaClassName(String suffix)

Returns JAVA class name for non implementation classes.

Parameters:

suffix - for the class name based on the file type

Returns:

java class name

generateJavaFile

public void generateJavaFile(int fileType,
                             org.onosproject.yang.compiler.datamodel.YangNode curNode)
                      throws IOException

Constructs java code exit.

Parameters:

fileType - generated file type

curNode - current YANG node

Throws:

IOException - when fails to generate java files

freeTemporaryResources

public void freeTemporaryResources(boolean errorOccurred)
                            throws IOException

Removes all temporary file handles.

Parameters:

errorOccurred - flag indicating if error occurred

Throws:

IOException - when failed to delete the temporary files

getIsQualifiedAccessOrAddToImportList

protected boolean getIsQualifiedAccessOrAddToImportList(org.onosproject.yang.compiler.datamodel.javadatamodel.JavaQualifiedTypeInfo importInfo)

Returns if the attribute needs to be accessed in a qualified manner or not, if it needs to be imported, then the same needs to be done.

Parameters:

importInfo - import info

Returns:

status of the qualified access to the attribute

getAddToListInterfaceTempFileHandle

public File getAddToListInterfaceTempFileHandle()

Returns temp file handle for add to list interface.

Returns:

temp file handle for add to list interface

getAddToListImplTempFileHandle

public File getAddToListImplTempFileHandle()

Returns temp file handle for add to list impl.

Returns:

temp file handle for add to list impl

getLeafIdAttributeTempFileHandle

public File getLeafIdAttributeTempFileHandle()

Returns temp file handle for leaf identifier attributes.

Returns:

temp file handle for leaf identifier attributes

getEditContentTempFileHandle

public File getEditContentTempFileHandle()

Returns temp file for edit content file.

Returns:

temp file for edit content file

setAttrNode

public void setAttrNode(org.onosproject.yang.compiler.datamodel.YangNode attrNode)

Sets attribute's node.

Parameters:

attrNode - attribute's node