Interface ICategory


  • public interface ICategory
    • Method Detail

      • getName

        java.lang.String getName()
        Get the name of this category.
      • getCategories

        Category[] getCategories()
        Get all categories in this category.
        Returns:
        zero-length array if there are no categories
      • getDataTypes

        DataType[] getDataTypes()
        Get all data types in this category.
        Returns:
        zero-length array if there are no data types
      • getCategory

        Category getCategory​(java.lang.String name)
        Get a category with the given name.
        Parameters:
        name - the name of the category
        Returns:
        null if there is no category by this name
      • getDataType

        DataType getDataType​(java.lang.String name)
        Get a data type with the given name.
        Parameters:
        name - the name of the data type
        Returns:
        null if there is no data type by this name
      • removeCategory

        boolean removeCategory​(java.lang.String name,
                               TaskMonitor monitor)
        Remove the named category from this category.
        Parameters:
        name - the name of the category to remove
        monitor - the task monitor
        Returns:
        true if the category was removed
      • moveCategory

        void moveCategory​(Category category,
                          TaskMonitor monitor)
                   throws DuplicateNameException
        Move the given category to this category; category is removed from its original parent category.
        Parameters:
        category - the category to move
        Throws:
        DuplicateNameException - if this category already contains a category or data type with the same name as the category param.
      • copyCategory

        Category copyCategory​(Category category,
                              DataTypeConflictHandler handler,
                              TaskMonitor monitor)
        Make a new subcategory from the given category.
        Parameters:
        category - the category to copy into this category
        Returns:
        category that is added to this category
      • getParent

        Category getParent()
        Return this category's parent; return null if this is the root category.
      • isRoot

        boolean isRoot()
      • getCategoryPathName

        java.lang.String getCategoryPathName()
        Get the fully qualified name for this category.
      • getRoot

        Category getRoot()
        Get the root category.
      • getDataTypeManager

        DataTypeManager getDataTypeManager()
        Get the data type manager associated with this category.