[ONOS-3908] YANG container translator.
Change-Id: I4e239509df747238905ca0995f41019679093627
diff --git a/utils/yangutils/src/main/java/org/onosproject/yangutils/translator/tojava/CachedJavaFileHandle.java b/utils/yangutils/src/main/java/org/onosproject/yangutils/translator/tojava/CachedJavaFileHandle.java
index ac917aa..c6fcea49 100644
--- a/utils/yangutils/src/main/java/org/onosproject/yangutils/translator/tojava/CachedJavaFileHandle.java
+++ b/utils/yangutils/src/main/java/org/onosproject/yangutils/translator/tojava/CachedJavaFileHandle.java
@@ -27,26 +27,18 @@
import org.onosproject.yangutils.datamodel.YangType;
import org.onosproject.yangutils.translator.CachedFileHandle;
import org.onosproject.yangutils.translator.GeneratedFileType;
+import org.onosproject.yangutils.translator.tojava.utils.AttributesJavaDataType;
import org.onosproject.yangutils.translator.tojava.utils.JavaCodeSnippetGen;
+import org.onosproject.yangutils.translator.tojava.utils.JavaFileGenerator;
import org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax;
import org.onosproject.yangutils.translator.tojava.utils.MethodsGenerator;
import org.onosproject.yangutils.utils.UtilConstants;
-import org.onosproject.yangutils.utils.io.impl.FileSystemUtil;
-import org.onosproject.yangutils.utils.io.impl.JavaDocGen;
-import org.onosproject.yangutils.utils.io.impl.SerializedDataStore;
-import org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType;
-import org.onosproject.yangutils.utils.io.impl.CopyrightHeader;
-
-import static org.slf4j.LoggerFactory.getLogger;
-import org.slf4j.Logger;
/**
* Maintain the information about the java file to be generated.
*/
public class CachedJavaFileHandle implements CachedFileHandle {
- private static final Logger log = getLogger(CachedJavaFileHandle.class);
-
private static final int MAX_CACHABLE_ATTR = 64;
private static final String JAVA_FILE_EXTENSION = ".java";
private static final String TEMP_FILE_EXTENSION = ".tmp";
@@ -58,12 +50,6 @@
private GeneratedFileType genFileTypes;
/**
- * The type(s) of java method to be generated when the cached file handle is
- * closed.
- */
- private GeneratedMethodTypes genMethodTypes;
-
- /**
* Java package in which the class/interface needs to be generated.
*/
private String pkg;
@@ -90,9 +76,14 @@
private List<AttributeInfo> attributeList;
/**
+ * File generation directory path.
+ */
+ private String filePath;
+
+ /**
* Prevent invoking default constructor.
*/
- private CachedJavaFileHandle() {
+ public CachedJavaFileHandle() {
setCachedAttributeList(new LinkedList<AttributeInfo>());
}
@@ -106,16 +97,9 @@
* @throws IOException file IO exception.
*/
public CachedJavaFileHandle(String pcg, String yangName, GeneratedFileType types) throws IOException {
- if ((new File(pcg).exists())) {
- setGeneratedFileTypes(types);
- setPackage(pcg);
- setYangName(yangName);
- } else {
- FileSystemUtil.createPackage(pcg, yangName);
- setGeneratedFileTypes(types);
- setPackage(pcg);
- setYangName(yangName);
- }
+ setGeneratedFileTypes(types);
+ setPackage(pcg);
+ setYangName(yangName);
}
/**
@@ -185,11 +169,6 @@
return childsPkg;
}
- /**
- * Set the java package.
- *
- * @param pcg the package to set
- */
@Override
public void setChildsPackage(String pcg) {
childsPkg = pcg;
@@ -251,13 +230,27 @@
attributeList = attrList;
}
+ @Override
+ public void setFilePath(String path) {
+ filePath = path;
+ }
+
+ /**
+ * Set the cached attribute list.
+ *
+ * @param attrList attribute list.
+ */
+ private String getFilePath() {
+ return filePath;
+ }
+
/**
* Flush the cached attribute list to the serialized file.
*/
- private void flushCacheAttrToSerFile() {
+ private void flushCacheAttrToSerFile(String className) {
for (AttributeInfo attr : getCachedAttributeList()) {
- parseAttributeInfo(attr);
+ JavaFileGenerator.parseAttributeInfo(attr, getGeneratedFileTypes(), className);
}
/*
@@ -279,10 +272,6 @@
AttributeInfo newAttr = new AttributeInfo();
if (attrType != null) {
- attrType.setDataTypeName(attrType.getDataTypeName().replace("\"", ""));
- if (attrType.getDataTypeName().equals("string")) {
- attrType.setDataTypeName(JavaIdentifierSyntax.getCaptialCase(attrType.getDataTypeName()));
- }
newAttr.setAttributeType(attrType);
} else {
ImportInfo importInfo = new ImportInfo();
@@ -301,6 +290,10 @@
newAttr.setAttributeName(name);
newAttr.setListAttr(isListAttr);
+ if (newAttr.isListAttr()) {
+ newAttr.setAttributeType(AttributesJavaDataType.getListString(newAttr));
+ }
+
if (isListAttr) {
String listImport = UtilConstants.COLLECTION_IMPORTS + UtilConstants.LIST + UtilConstants.SEMI_COLAN
+ UtilConstants.NEW_LINE + UtilConstants.NEW_LINE;
@@ -317,7 +310,7 @@
if (getCachedAttributeList() != null) {
if (getCachedAttributeList().size() == MAX_CACHABLE_ATTR) {
- flushCacheAttrToSerFile();
+ flushCacheAttrToSerFile(getYangName());
}
getCachedAttributeList().add(newAttr);
} else {
@@ -361,89 +354,19 @@
String className = getYangName();
className = JavaIdentifierSyntax.getCaptialCase(className);
- String packagePath = getPackage();
- String filePath = UtilConstants.YANG_GEN_DIR + packagePath.replace(".", "/");
+ String filePath = getFilePath();
GeneratedFileType fileType = getGeneratedFileTypes();
- /**
- * Create interface file.
- */
- String interfaceFileName = className + JAVA_FILE_EXTENSION;
- File interfaceFile = new File(filePath + File.separator + interfaceFileName);
-
- /**
- * Create temp builder interface file.
- */
- String builderInterfaceFileName = interfaceFileName + TEMP_FILE_EXTENSION;
- File builderInterfaceFile = new File(filePath + File.separator + builderInterfaceFileName);
-
- /**
- * Create builder class file.
- */
- String builderFileName = className + UtilConstants.BUILDER + JAVA_FILE_EXTENSION;
- File builderFile = new File(filePath + File.separator + builderFileName);
- MethodsGenerator.setBuilderClassName(className + UtilConstants.BUILDER);
-
- /**
- * Create temp impl class file.
- */
-
- String implFileName = className + UtilConstants.IMPL + TEMP_FILE_EXTENSION;
- File implTempFile = new File(filePath + File.separator + implFileName);
-
/*
* TODO: add the file header using
* JavaCodeSnippetGen.getFileHeaderComment
*/
- List<String> attributes = new LinkedList<>();
- List<String> interfaceMethods = new LinkedList<>();
- List<String> builderInterfaceMethods = new LinkedList<>();
- List<String> builderClassMethods = new LinkedList<>();
- List<String> implClassMethods = new LinkedList<>();
List<String> imports = new LinkedList<>();
- try {
- attributes = SerializedDataStore.getSerializeData(SerializedDataStore.SerializedDataStoreType.ATTRIBUTE);
-
- interfaceMethods = SerializedDataStore
- .getSerializeData(SerializedDataStore.SerializedDataStoreType.INTERFACE_METHODS);
-
- builderInterfaceMethods = SerializedDataStore
- .getSerializeData(SerializedDataStore.SerializedDataStoreType.BUILDER_INTERFACE_METHODS);
-
- builderClassMethods = SerializedDataStore
- .getSerializeData(SerializedDataStore.SerializedDataStoreType.BUILDER_METHODS);
-
- implClassMethods = SerializedDataStore
- .getSerializeData(SerializedDataStore.SerializedDataStoreType.IMPL_METHODS);
-
- imports = SerializedDataStore.getSerializeData(SerializedDataStore.SerializedDataStoreType.IMPORT);
- } catch (ClassNotFoundException | IOException e) {
- log.info("There is no attribute info of " + className + " YANG file in the serialized files.");
- }
-
if (getCachedAttributeList() != null) {
MethodsGenerator.setAttrInfo(getCachedAttributeList());
for (AttributeInfo attr : getCachedAttributeList()) {
- if (attr.isListAttr()) {
- String listString = JavaCodeSnippetGen.getListAttribute(attr.getAttributeType().getDataTypeName());
- @SuppressWarnings("rawtypes")
- YangType<?> type = new YangType();
- type.setDataTypeName(listString);
- attr.setAttributeType(type);
- }
-
- attributes.add(getAttributeString(attr));
-
- interfaceMethods.add(MethodsGenerator.getMethodString(attr, GeneratedFileType.INTERFACE));
-
- builderClassMethods.add(MethodsGenerator.getMethodString(attr, GeneratedFileType.BUILDER_CLASS));
-
- builderInterfaceMethods
- .add(MethodsGenerator.getMethodString(attr, GeneratedFileType.BUILDER_INTERFACE));
-
- implClassMethods.add(MethodsGenerator.getMethodString(attr, GeneratedFileType.IMPL));
if (getImportSet() != null) {
imports = new ArrayList<>(getImportSet());
@@ -451,288 +374,73 @@
}
}
- builderInterfaceMethods.add(MethodsGenerator.parseBuilderInterfaceBuildMethodString(className));
- builderClassMethods.add(UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.JAVA_DOC_FIRST_LINE
- + MethodsGenerator.getDefaultConstructorString(GeneratedFileType.BUILDER_CLASS, className));
- builderClassMethods.add(MethodsGenerator.getBuildString(className));
-
- implClassMethods.add(UtilConstants.JAVA_DOC_FIRST_LINE
- + MethodsGenerator.getDefaultConstructorString(GeneratedFileType.IMPL, className));
- implClassMethods.add(MethodsGenerator.getConstructorString(className));
-
/**
* Start generation of files.
*/
if (fileType.equals(GeneratedFileType.INTERFACE) || fileType.equals(GeneratedFileType.ALL)) {
- initiateFile(interfaceFile, className, GeneratedFileType.INTERFACE, imports);
+
+ /**
+ * Create interface file.
+ */
+ String interfaceFileName = className;
+ File interfaceFile = new File(filePath + File.separator + interfaceFileName + JAVA_FILE_EXTENSION);
+ interfaceFile = JavaFileGenerator.generateInterfaceFile(interfaceFile, className, imports,
+ getCachedAttributeList(), getPackage());
+
+ /**
+ * Create temp builder interface file.
+ */
+ String builderInterfaceFileName = className + UtilConstants.BUILDER + UtilConstants.INTERFACE;
+ File builderInterfaceFile = new File(
+ filePath + File.separator + builderInterfaceFileName + TEMP_FILE_EXTENSION);
+ builderInterfaceFile = JavaFileGenerator.generateBuilderInterfaceFile(builderInterfaceFile, className,
+ getPackage(), getCachedAttributeList());
+
+ /**
+ * Append builder interface file to interface file and close it.
+ */
+ JavaFileGenerator.appendFileContents(builderInterfaceFile, interfaceFile);
+ JavaFileGenerator.insert(interfaceFile,
+ JavaFileGenerator.closeFile(GeneratedFileType.INTERFACE, interfaceFileName));
+
+ /**
+ * Remove temp files.
+ */
+ JavaFileGenerator.clean(builderInterfaceFile);
}
if (fileType.equals(GeneratedFileType.BUILDER_CLASS) || fileType.equals(GeneratedFileType.ALL)) {
- initiateFile(builderFile, className, GeneratedFileType.BUILDER_CLASS, imports);
- }
- if (fileType.equals(GeneratedFileType.IMPL) || fileType.equals(GeneratedFileType.ALL)) {
- initiateFile(implTempFile, className, GeneratedFileType.IMPL, imports);
- }
-
- if (fileType.equals(GeneratedFileType.BUILDER_INTERFACE) || fileType.equals(GeneratedFileType.ALL)) {
- initiateFile(builderInterfaceFile, className, GeneratedFileType.BUILDER_INTERFACE, imports);
- }
-
- /**
- * Add attributes to the file.
- */
- for (String attribute : attributes) {
- insert(builderFile, UtilConstants.NEW_LINE + UtilConstants.FOUR_SPACE_INDENTATION + attribute);
- insert(implTempFile, UtilConstants.NEW_LINE + UtilConstants.FOUR_SPACE_INDENTATION + attribute);
- }
-
- insert(builderFile, UtilConstants.NEW_LINE);
- insert(implTempFile, UtilConstants.NEW_LINE);
-
- /**
- * Add getter methods to interface file.
- */
- for (String method : interfaceMethods) {
- appendMethod(interfaceFile, method + UtilConstants.NEW_LINE);
- }
-
- /**
- * Add getters and setters in builder interface.
- */
- for (String method : builderInterfaceMethods) {
- appendMethod(builderInterfaceFile, UtilConstants.FOUR_SPACE_INDENTATION + method + UtilConstants.NEW_LINE);
- }
-
- insert(builderInterfaceFile, UtilConstants.CLOSE_CURLY_BRACKET + UtilConstants.NEW_LINE);
- /**
- * Add methods in builder class.
- */
- for (String method : builderClassMethods) {
- appendMethod(builderFile, method + UtilConstants.NEW_LINE);
- }
-
- /**
- * Add methods in impl class.
- */
- for (String method : implClassMethods) {
- appendMethod(implTempFile, UtilConstants.FOUR_SPACE_INDENTATION + method + UtilConstants.NEW_LINE);
- }
-
- insert(implTempFile, UtilConstants.CLOSE_CURLY_BRACKET + UtilConstants.NEW_LINE);
-
- /**
- * Append builder interface file to interface file and close it.
- */
- appendFileContents(builderInterfaceFile, interfaceFile);
- insert(interfaceFile, closeFile(GeneratedFileType.INTERFACE, interfaceFileName));
-
- /**
- * Append impl class to builder class and close it.
- */
- appendFileContents(implTempFile, builderFile);
- insert(builderFile, closeFile(GeneratedFileType.BUILDER_CLASS, builderFileName));
-
- /**
- * Remove temp files.
- */
- clean(implTempFile);
- clean(builderInterfaceFile);
- }
-
- /**
- * Initiate generation of file based on generated file type.
- *
- * @param file generated file
- * @param className generated file class name
- * @param type generated file type
- * @param imports imports for the file
- * @throws IOException when fails to generate a file
- */
- private void initiateFile(File file, String className, GeneratedFileType type, List<String> imports)
- throws IOException {
- try {
- file.createNewFile();
- appendContents(file, className, type, imports);
- } catch (IOException e) {
- throw new IOException("Failed to create " + file.getName() + " class file.");
- }
- }
-
- /**
- * Appends the temp files to main files.
- *
- * @param appendFile temp file
- * @param srcFile main file
- */
- private static void appendFileContents(File appendFile, File srcFile) throws IOException {
- try {
- FileSystemUtil.appendFileContents(appendFile, srcFile);
- } catch (IOException e) {
- throw new IOException("Failed to append " + appendFile + " in " + srcFile);
- }
- }
-
- /**
- * Append methods to the generated files.
- *
- * @param file file in which method needs to be appended.
- * @param method method which needs to be appended.
- */
- private static void appendMethod(File file, String method) throws IOException {
- insert(file, method);
- }
-
- /**
- * Closes the current generated file.
- *
- * @param fileType generate file type
- * @param yangName file name
- * @return end of class definition string.
- */
- private static String closeFile(GeneratedFileType fileType, String yangName) {
- return JavaCodeSnippetGen.getJavaClassDefClose(fileType, yangName);
- }
-
- /**
- * Parses attribute info and fetch specific data and creates serialized
- * files of it.
- *
- * @param attr attribute info.
- */
- private void parseAttributeInfo(AttributeInfo attr) {
-
- String attrString = "";
- String methodString = "";
- String getterString = "";
-
- try {
- /*
- * Serialize attributes.
+ /**
+ * Create builder class file.
*/
- attrString = getAttributeString(attr);
- attrString = attrString.replace("\"", "");
- SerializedDataStore.setSerializeData(attrString, SerializedDataStore.SerializedDataStoreType.ATTRIBUTE);
+ String builderFileName = className + UtilConstants.BUILDER;
+ File builderFile = new File(filePath + File.separator + builderFileName + JAVA_FILE_EXTENSION);
+ MethodsGenerator.setBuilderClassName(className + UtilConstants.BUILDER);
- if (getGeneratedFileTypes().equals(GeneratedFileType.ALL)) {
+ builderFile = JavaFileGenerator.generateBuilderClassFile(builderFile, className, imports, getPackage(),
+ getCachedAttributeList());
- methodString = MethodsGenerator.getMethodString(attr, GeneratedFileType.INTERFACE);
- SerializedDataStore.setSerializeData(methodString,
- SerializedDataStore.SerializedDataStoreType.INTERFACE_METHODS);
+ /**
+ * Create temp impl class file.
+ */
- methodString = MethodsGenerator.getMethodString(attr, GeneratedFileType.BUILDER_CLASS);
- SerializedDataStore.setSerializeData(methodString,
- SerializedDataStore.SerializedDataStoreType.BUILDER_METHODS);
+ String implFileName = className + UtilConstants.IMPL;
+ File implTempFile = new File(filePath + File.separator + implFileName + TEMP_FILE_EXTENSION);
+ implTempFile = JavaFileGenerator.generateImplClassFile(implTempFile, className, getPackage(),
+ getCachedAttributeList());
- methodString = MethodsGenerator.getMethodString(attr, GeneratedFileType.BUILDER_INTERFACE);
- SerializedDataStore.setSerializeData(methodString,
- SerializedDataStore.SerializedDataStoreType.BUILDER_INTERFACE_METHODS);
+ /**
+ * Append impl class to builder class and close it.
+ */
+ JavaFileGenerator.appendFileContents(implTempFile, builderFile);
+ JavaFileGenerator.insert(builderFile,
+ JavaFileGenerator.closeFile(GeneratedFileType.BUILDER_CLASS, builderFileName));
- methodString = MethodsGenerator.getMethodString(attr, GeneratedFileType.IMPL);
- SerializedDataStore.setSerializeData(methodString,
- SerializedDataStore.SerializedDataStoreType.IMPL_METHODS);
-
- } else if (getGeneratedFileTypes().equals(GeneratedFileType.INTERFACE)) {
-
- getterString = MethodsGenerator.getGetterString(attr);
- SerializedDataStore.setSerializeData(methodString,
- SerializedDataStore.SerializedDataStoreType.INTERFACE_METHODS);
- }
- } catch (IOException e) {
- log.info("Failed to get data for " + attr.getAttributeName() + " from serialized files.");
- }
- }
-
- /**
- * Returns attribute string.
- *
- * @param attr attribute info
- * @return attribute string
- */
- private String getAttributeString(AttributeInfo attr) {
- return JavaCodeSnippetGen.getJavaAttributeInfo(getGeneratedFileTypes(), attr.getAttributeName(),
- attr.getAttributeType());
- }
-
- /**
- * Appends all the contents into a generated java file.
- *
- * @param file generated file
- * @param fileName generated file name
- * @param type generated file type
- */
- private void appendContents(File file, String fileName, GeneratedFileType type, List<String> importsList)
- throws IOException {
-
- if (type.equals(GeneratedFileType.IMPL)) {
-
- write(file, fileName, type, JavaDocType.IMPL_CLASS);
- } else if (type.equals(GeneratedFileType.BUILDER_INTERFACE)) {
-
- write(file, fileName, type, JavaDocType.BUILDER_INTERFACE);
- } else {
-
- // TODO: handle imports for attributes.
-
- if (type.equals(GeneratedFileType.INTERFACE)) {
- insert(file, CopyrightHeader.getCopyrightHeader());
- insert(file, "package" + UtilConstants.SPACE + getPackage() + UtilConstants.SEMI_COLAN
- + UtilConstants.NEW_LINE + UtilConstants.NEW_LINE);
- for (String imports : importsList) {
- insert(file, imports);
- }
- insert(file, UtilConstants.NEW_LINE);
- write(file, fileName, type, JavaDocType.INTERFACE);
- } else if (type.equals(GeneratedFileType.BUILDER_CLASS)) {
- insert(file, CopyrightHeader.getCopyrightHeader());
- insert(file, "package" + UtilConstants.SPACE + getPackage() + UtilConstants.SEMI_COLAN
- + UtilConstants.NEW_LINE + UtilConstants.NEW_LINE);
- for (String imports : importsList) {
- insert(file, imports);
- }
- insert(file, UtilConstants.NEW_LINE);
- write(file, fileName, type, JavaDocType.BUILDER_CLASS);
- }
- }
- }
-
- /**
- * Write data to the specific generated file.
- *
- * @param file generated file
- * @param fileName file name
- * @param genType generated file type
- * @param javaDocType java doc type
- */
- private static void write(File file, String fileName, GeneratedFileType genType, JavaDocGen.JavaDocType javaDocType)
- throws IOException {
-
- insert(file, JavaDocGen.getJavaDoc(javaDocType, fileName));
- insert(file, JavaCodeSnippetGen.getJavaClassDefStart(genType, fileName));
- }
-
- /**
- * Insert in the generated file.
- *
- * @param file file in which need to be inserted.
- * @param data data which need to be inserted.
- */
- private static void insert(File file, String data) throws IOException {
- try {
- FileSystemUtil.insertStringInFile(file, data);
- } catch (IOException e) {
- throw new IOException("Failed to insert in " + file + "file");
- }
- }
-
- /**
- * Removes temp files.
- *
- * @param file file to be removed.
- */
- private static void clean(File file) {
- if (file.exists()) {
- file.delete();
+ /**
+ * Remove temp files.
+ */
+ JavaFileGenerator.clean(implTempFile);
}
}
}