Interface VltEntries


public interface VltEntries
The vault entries provide meta information about the entries under vault control. Note that entries are managed by their respective MetaDirectory and updates to this entries are only persisted if the directory is synced or closed.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns all entries.
    getEntry(String localName)
    Returns the vault entry for the given name
    Returns the platform path of this entries relative to the vault root.
    boolean
    hasEntry(String localName)
    Checks if the entry with the given name exists
    update(String localName, String aggregatePath, String repoRelPath)
    Updates the paths properties of the entry with localName.
    void
    Updates the entry with the state contained in the vault file.
  • Method Details

    • getPath

      String getPath()
      Returns the platform path of this entries relative to the vault root.
      Returns:
      the platform path
    • hasEntry

      boolean hasEntry(String localName)
      Checks if the entry with the given name exists
      Parameters:
      localName - name of the entry
      Returns:
      true if exists
    • getEntry

      VltEntry getEntry(String localName)
      Returns the vault entry for the given name
      Parameters:
      localName - the name of the entry
      Returns:
      the entry or null if not exists.
    • update

      void update(VltFile file)
      Updates the entry with the state contained in the vault file.
      Parameters:
      file - the vault file.
    • update

      VltEntry update(String localName, String aggregatePath, String repoRelPath)
      Updates the paths properties of the entry with localName. If the entry did not exist yet, a new one is created.
      Parameters:
      localName - the name of the entry
      aggregatePath - the new aggregate path
      repoRelPath - the new repository path
      Returns:
      the entry that was updated.
    • entries

      Collection<VltEntry> entries()
      Returns all entries.
      Returns:
      the entries