Class TwoLevelHint

    • Constructor Summary

      Constructors 
      Constructor Description
      TwoLevelHint()
      DO NOT USE THIS CONSTRUCTOR, USE create*(GenericFactory ...) FACTORY METHODS INSTEAD.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getSubImageIndex()
      An index into the sub-images (sub-frameworks and sub-umbrellas list).
      int getTableOfContentsIndex()
      An index into the library's table of contents.
      DataType toDataType()
      Returns a structure datatype representing the contents of the implementor of this interface.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TwoLevelHint

        public TwoLevelHint()
        DO NOT USE THIS CONSTRUCTOR, USE create*(GenericFactory ...) FACTORY METHODS INSTEAD.
    • Method Detail

      • getSubImageIndex

        public int getSubImageIndex()
        An index into the sub-images (sub-frameworks and sub-umbrellas list).
        Returns:
        index into the sub-images
      • getTableOfContentsIndex

        public int getTableOfContentsIndex()
        An index into the library's table of contents.
        Returns:
        index into the library's table of contents
      • toDataType

        public DataType toDataType()
                            throws DuplicateNameException,
                                   java.io.IOException
        Description copied from interface: StructConverter
        Returns a structure datatype representing the contents of the implementor of this interface.

        For example, given:

         class A {
             int foo;
             double bar;
         }
         

        The return value should be a structure data type with two data type components; an INT and a DOUBLE. The structure should contain field names and, if possible, field comments.

        Specified by:
        toDataType in interface StructConverter
        Returns:
        returns a structure datatype representing the implementor of this interface
        Throws:
        DuplicateNameException - when a datatype of the same name already exists
        java.io.IOException
        See Also:
        StructureDataType