Field Detail

• sVersion

  public static final java.lang.String sVersion

  Version, history and license.

  • 2014-09-05 Hartmut chg: setFileJava(String, File, String, org.vishia.java2C.ConfigSrcPathPkg_ifc.Set, String, boolean) not used arguments removed. The arguments String prefixCFile, String suffixCFile, String prefixNames, String suffixNames are contained in the ConfigSrcPathPkg_ifc.Set info already.
  • 2014-09-05 Hartmut new: setFileAndReadStcFile(String, org.vishia.java2C.ConfigSrcPathPkg_ifc.Set, String). This is one method which reads all information about a Java class from a existing stc file, especially used for C-written parts read in CRuntimeJavalikeClassData.
  • 2008 Hartmut created:

  
  
  Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

  1. You can use this source without any restriction for any desired purpose.
  2. You can redistribute copies of this source to everybody.
  3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
  4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
  5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

  If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

  See Also:

  Constant Field Values

Constructor Detail

• JavaSrcTreePkg

  public JavaSrcTreePkg(JavaSrcTreePkg parent,
                java.lang.String pkgPath,
                java.lang.String pkgName,
                ConfigSrcPathPkg_ifc.Set replaceCinfo)

  Parameters:

  pkgIdent -

  javaSrcPath -

Method Detail

• getOrAddPkg

  public JavaSrcTreePkg getOrAddPkg(java.lang.String pkgPath,
                           java.lang.String pkgName,
                           ConfigSrcPathPkg_ifc.Set replaceCinfo)

  returns the Instance, which represents the given package name. If the Instance doesn't exist, it is created. If it exists already before this call, and its replaceCinfo is null, then the given parameter replaceCinfo is used to set it. If the replaceCinfo was given before, and the parameter replaceCinfo is given here too, it is tested whether it contains the same. Elsewhere a IllegalArgumentException is thrown.

  Parameters:

  pkgPath - The full path from root

  pkgName - The name of the new package

  replaceCinfo - if not null, then it is the info to build the C-files /search the stc-file for all non-existing, but needed Java-files of the package.

  Returns:

  The package management instance.

• putClassType

  public void putClassType(org.vishia.java2C.ClassData data)

  Adds the given type info to the pkgIdents.

  Parameters:

  data - The type info.

• getPkgPath

  public java.lang.String getPkgPath()

• XXXgetJavaFiles

  public final java.util.TreeMap<java.lang.String,JavaSrcTreeFile> XXXgetJavaFiles()

• getPublicClasses

  public final java.util.List<JavaSources.ClassDataOrJavaSrcFile> getPublicClasses()

• xxxaddStdTypes

  public void xxxaddStdTypes(LocalIdents types)

  Adds all standard types to the package. This method will be called if any file is containing in the package. It means, the package is the immediate package of any class. This method will be called too while creating a standard package (java.lang).

  Parameters:

  types -

• setFileJava

  public JavaSources.ClassDataOrJavaSrcFile setFileJava(java.lang.String javaSrcPath,
                                               java.io.File fileJava,
                                               java.lang.String sFileNameJava,
                                               ConfigSrcPathPkg_ifc.Set info,
                                               java.lang.String stcPath,
                                               boolean translateToC)

  Registers the occurrence of a found Java file or set the ConfigSrcPathPkg_ifc.Set for an existing file without replaceCinfo

  Parameters:

  javaSrcPath - The source path where the file is found. It may be null for Classes, which are presented by its stc file only.

  fileJava - The File instance ready to the open source file. null if javaSrcPath ==null.

  sFileNameJava - The file name without path but with extension .java without directories. The class Name if a stc file will be registered.

  info - informations to find out where the C-file is found and which pre/suffix are valid.

  stcPath - null or a special path where the stc-file is located.

  translateToC - false than the file should not be translate to C, instead the stc-file should be used any time. This is if it is a standard class or a users class, which is located in a library.

  Returns:

• setFileAndReadStcFile

  public org.vishia.java2C.ClassData setFileAndReadStcFile(java.lang.String sClassname,
                                                  ConfigSrcPathPkg_ifc.Set info,
                                                  java.lang.String stcPath)
                                                    throws java.text.ParseException

  Registers a Java class inside the given package and reads the associated stc file.

  Parameters:

  sClassname - The class name

  info - info about the path to C files

  stcPath - Path to stc-File, maybe null if the stc file has the same path then the associated C file with extension .stc.

  Returns:

  the ClassData. That ClassData are stored in this pkgIdents too, using LocalIdents.getType(String, LocalIdents) to get it. The return value is used inside CRuntimeJavalikeClassData if the ClassData are used there.

  Throws:

  java.text.ParseException - on faulty stc file.

• reportClasses

  public void reportClasses(org.vishia.mainCmd.Report report)

• getChild

  public JavaSrcTreePkg getChild(java.lang.String key)

  Description copied from interface: org.vishia.util.SortedTree
  Searches the first child with given key from the given node this.

  Specified by:

  getChild in interface org.vishia.util.SortedTree<JavaSrcTreePkg>

  Parameters:

  key - The key of the demanded child. The implementation may have extra possibilities in addressing children with strings. The sKey can be representing more as a simple string as a attribute in children. It may be comparable with the ability of XPATH in XML. But it will be a feature of Implementation and is not defined as a basic feature of this interface.
  sKey==null or sKey="" should be accepted. Than the first child independed on its key is returned. This is useable if only one child exists, but with unknown key.

  Returns:

  The first child with the given key or null if there is no such child.

• getPkgLevelIdents

  public LocalIdents getPkgLevelIdents()

  gets the pkg-level-idents. It contains all types which are known at this package level (all files of package.).

• iterChildren

  public java.util.Iterator<JavaSrcTreePkg> iterChildren()

  Description copied from interface: org.vishia.util.SortedTree
  Returns an iterator through the list of all children of the node.

  Specified by:

  iterChildren in interface org.vishia.util.SortedTree<JavaSrcTreePkg>

  Returns:

  The iterator or null if there isn't any children.

• iterChildren

  public java.util.Iterator<JavaSrcTreePkg> iterChildren(java.lang.String key)

  Description copied from interface: org.vishia.util.SortedTree
  Returns an iterator through the list of all children with the given key.

  Specified by:

  iterChildren in interface org.vishia.util.SortedTree<JavaSrcTreePkg>

  Parameters:

  key - The key of the demanded child. The implementation may have extra possibilities, see getChild(String).

  Returns:

  A iterator through the list of all children with the given key or null if there is no such child.

• listChildren

  public java.util.List<JavaSrcTreePkg> listChildren()

  Description copied from interface: org.vishia.util.SortedTree
  Returns a List of all children of the node.

  Specified by:

  listChildren in interface org.vishia.util.SortedTree<JavaSrcTreePkg>

  Returns:

  The List or null if there isn't any children.

• listChildren

  public java.util.List<JavaSrcTreePkg> listChildren(java.lang.String key)

  Description copied from interface: org.vishia.util.SortedTree
  Returns a List of all children with the given key.

  Specified by:

  listChildren in interface org.vishia.util.SortedTree<JavaSrcTreePkg>

  Parameters:

  key - The key of the demanded child. The implementation may have extra possibilities, see getChild(String).

  Returns:

  A List of all children with the given key or null if there is no such child.

• getClassData

  public org.vishia.java2C.ClassData getClassData()

  Description copied from interface: JavaSources.ClassDataOrJavaSrcFile
  Returns the ClassData of the instance, or null. If the instance is of type ClassData, it returns the instance itself. If the instance is of type JavaSrcTreeFile, it returns the associated ClassData, if the file is translated yet or the stc-file is read already. If the file isn't translated, it returns null.

  Specified by:

  getClassData in interface JavaSources.ClassDataOrJavaSrcFile

• getJavaSrc

  public JavaSrcTreeFile getJavaSrc()

  Implements JavaSources.ClassDataOrJavaSrcFile.getJavaSrc()

  Specified by:

  getJavaSrc in interface JavaSources.ClassDataOrJavaSrcFile

• getJavaPkg

  public JavaSrcTreePkg getJavaPkg()

  Implements JavaSources.ClassDataOrJavaSrcFile.getJavaPkg()

  Specified by:

  getJavaPkg in interface JavaSources.ClassDataOrJavaSrcFile

• getLocalIdents

  public LocalIdents getLocalIdents(java.lang.String sPkgName)

  Returns the identifier of classes or packages, which are available in this package. It may be sub-package or a file or a class known in package. implements JavaSources.ClassDataOrJavaSrcFile.getLocalIdents(java.lang.String)

  Specified by:

  getLocalIdents in interface JavaSources.ClassDataOrJavaSrcFile

  Parameters:

  sPkgName: - It is ignored.

  Returns:

  Especially list of all types in the element. If it is a package, the types may be the files in the package or sub-packages.

• getTypeName

  public java.lang.String getTypeName()

  Implements JavaSources.ClassDataOrJavaSrcFile.getTypeName()

  Specified by:

  getTypeName in interface JavaSources.ClassDataOrJavaSrcFile

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

• getReplaceCinfo

  public ConfigSrcPathPkg_ifc.Set getReplaceCinfo()

  Description copied from interface: JavaSources.ClassDataOrJavaSrcFile
  Returns the informations to find out where the C-file is found and which pre/suffix are valid.

  Specified by:

  getReplaceCinfo in interface JavaSources.ClassDataOrJavaSrcFile

  Returns:

  null if there are not such informations. That is especially for super-paths.

• isToTranslate

  public boolean isToTranslate()

  returns false because a package isn't to translate.

  Specified by:

  isToTranslate in interface JavaSources.ClassDataOrJavaSrcFile

  Returns:

  false if always the stc-File is to be read, or it is a ClassData.

  See Also:

  JavaSources.ClassDataOrJavaSrcFile.isToTranslate()

• setClassData

  public void setClassData(org.vishia.java2C.ClassData data)

  Specified by:

  setClassData in interface JavaSources.ClassDataOrJavaSrcFile

• getParent

  public JavaSrcTreePkg getParent()

  Specified by:

  getParent in interface org.vishia.util.SortedTree<JavaSrcTreePkg>