Class CometIndex

All Implemented Interfaces:
Serializable

The type Comet index. Internal use only.
See Also:
  • Constructor Details

    • CometIndex

      public CometIndex()
      Instantiates a new Comet index.
  • Method Details

    • addOrUpdateEntry

      public void addOrUpdateEntry(String label, String path)
      Add or update entry.
      Parameters:
      label - the label
      path - the path
    • getItems

      public List<CometIndex.CometIndexEntry> getItems()
      Gets items.
      Returns:
      the items
    • getLabel

      public String getLabel()
      Gets label.
      Returns:
      the label
    • getReferenceConstraints

      public List<CometReference> getReferenceConstraints()
      Description copied from class: CometEntity

      Get reference (i.e. PluginDependency) constraints for this type, including constraints inherited from super classes

      See the CometTypeConstraints annotation for more information

      Overrides:
      getReferenceConstraints in class CometEntity
      Returns:
      list of mandatory dependencies for this type
    • getRepositoryFilename

      public String getRepositoryFilename() throws CometException
      Description copied from class: CometEntity

      Gets the repository filename for this particular item

      This method MUST be overridden by classes extending CometEntity

      Overrides:
      getRepositoryFilename in class CometEntity
      Returns:
      the repository filename of this particular item
      Throws:
      CometException - the comet exception
    • getRepositoryPath

      public String getRepositoryPath() throws CometException
      Description copied from class: CometEntity

      Get the relative repository path for this configuration type.

      This method MUST be overridden by classes extending CometEntity.

      Overrides:
      getRepositoryPath in class CometEntity
      Returns:
      relative repository path
      Throws:
      CometException - the comet exception
    • removeEntry

      public void removeEntry(String path)
      Remove entry.
      Parameters:
      path - the path
    • setItems

      public void setItems(List<CometIndex.CometIndexEntry> items)
      Sets items.
      Parameters:
      items - the items
    • setLabel

      public void setLabel(String label)
      Sets label.
      Parameters:
      label - the label