Interface VltEntries
-
public interface VltEntriesThe vault entries provide meta information about the entries under vault control. Note that entries are managed by their respectiveMetaDirectoryand updates to this entries are only persisted if the directory is synced or closed.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Collection<VltEntry>entries()Returns all entries.VltEntrygetEntry(String localName)Returns the vault entry for the given nameStringgetPath()Returns the platform path of this entries relative to the vault root.booleanhasEntry(String localName)Checks if the entry with the given name existsVltEntryupdate(String localName, String aggregatePath, String repoRelPath)Updates the paths properties of the entry withlocalName.voidupdate(VltFile file)Updates the entry with the state contained in the vault file.
-
-
-
Method Detail
-
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:
trueif 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
nullif 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 withlocalName. If the entry did not exist yet, a new one is created.- Parameters:
localName- the name of the entryaggregatePath- the new aggregate pathrepoRelPath- the new repository path- Returns:
- the entry that was updated.
-
entries
Collection<VltEntry> entries()
Returns all entries.- Returns:
- the entries
-
-