Class IdentifiedCollection.Base<T extends Identified>

Method Details

• add

  public void add(String identifier, Resource resource, ConstructionCallback<T> builder)

  Description copied from interface: IdentifiedCollection

  Add a potentially lazily constructed identified object to this collection.

  Specified by:

  add in interface IdentifiedCollection<T extends Identified>

  Parameters:

  identifier - uniquely identifies the to be constructed object

  resource - a Resource that is linked to the original object - may be Resource.UNKNOWN

  builder - a callback that will return the object - expect that the IdentifiedCollection will cache the result of this call

• remove

  public boolean remove(String id)

  Description copied from interface: IdentifiedCollection

  Removes an object from the collection

  Specified by:

  remove in interface IdentifiedCollection<T extends Identified>

  Returns:

  true if there was something in the collection with this id, failed or otherwise

• add

  public void add(@NonNull T identified)

  Description copied from interface: IdentifiedCollection

  Add a pre-constructed identified object to the collection.

  Specified by:

  add in interface IdentifiedCollection<T extends Identified>

  Parameters:

  identified - object to add

• add

  public void add(@NonNull T identified, @NonNull @NonNull Resource source)

  Description copied from interface: IdentifiedCollection

  Same as IdentifiedCollection.add(nz.org.riskscape.engine.Identified) but with specified source.

  Specified by:

  add in interface IdentifiedCollection<T extends Identified>

• addAll

  public void addAll(@NonNull @NonNull Collection<T> identifieds)

  Description copied from interface: IdentifiedCollection

  Add all of the given objects to this collection, returning a list of any that were replaced

  Specified by:

  addAll in interface IdentifiedCollection<T extends Identified>

• addAll

  public void addAll(Collection<T> identifieds, Resource source) throws ObjectAlreadyExistsException

  Description copied from interface: IdentifiedCollection

  Same as where each item of the collection can be assigned the same source.</p>

  Specified by:

  addAll in interface IdentifiedCollection<T extends Identified>

  Throws:

  ObjectAlreadyExistsException

• getAll

  public List<T> getAll()

  Specified by:

  getAll in interface IdentifiedCollection<T extends Identified>

  Returns:

  all items in the collection ordered by id, excluding failed things Note that any problems will be ignored.

• getAllProblems

  public List<Pair<String,List<Problem>>> getAllProblems()

  Specified by:

  getAllProblems in interface IdentifiedCollection<T extends Identified>

  Returns:

  A list of all the problems associated with any failed items in this collection.

• getReferences

  public List<Reference<T>> getReferences()

  Specified by:

  getReferences in interface IdentifiedCollection<T extends Identified>

  Returns:

  all items in the collection ordered by id

• get

  public T get(@NonNull @NonNull String id, ProblemSink problemSink)

  Description copied from interface: IdentifiedCollection

  Get an object from the collection that has the given id.

  Specified by:

  get in interface IdentifiedCollection<T extends Identified>

  Parameters:

  id - of item to get.

  problemSink - a place for any warnings or info problems to be sent during lookup/construction

  Returns:

  item

• getOr

  public ResultOrProblems<T> getOr(@NonNull @NonNull String id)

  Description copied from interface: IdentifiedCollection

  ResultOrProblems returning alternative to get, which will return the same problems that a NoSuchObjectException or a FailedObjectException would have, but as part of a ResultOrProblems. Also adds any warnings that were encountered in to the result.

  Specified by:

  getOr in interface IdentifiedCollection<T extends Identified>

• determineCollectionClass

  public Class<T> determineCollectionClass()

• getResult

  public Optional<ResultOrProblems<T>> getResult(@NonNull @NonNull String id)

  Description copied from interface: IdentifiedCollection

  Alternative to get that returns the result wrapped in an Optional and a ResultOrProblems instead of throwing IdentifiedExceptions.

  Specified by:

  getResult in interface IdentifiedCollection<T extends Identified>

• containsKey

  public boolean containsKey(@NonNull @NonNull String id)

  Specified by:

  containsKey in interface IdentifiedCollection<T extends Identified>

  Returns:

  true if collection contains an item with matching id

• isEmpty

  public boolean isEmpty()

  Specified by:

  isEmpty in interface IdentifiedCollection<T extends Identified>

  Returns:

  true of this collection contains no entries, failed or otherwise

• clear

  public void clear()

  Description copied from interface: IdentifiedCollection

  Remove everything from the collection

  Specified by:

  clear in interface IdentifiedCollection<T extends Identified>

• removeAll

  protected void removeAll(@NonNull @NonNull Collection<T> items)

• getSimilarIds

  public List<String> getSimilarIds(String candidate)

  Description copied from interface: IdentifiedCollection

  Find possible matches for a failed id lookup.

  Specified by:

  getSimilarIds in interface IdentifiedCollection<T extends Identified>

  Parameters:

  candidate - the id that doesn't exist in this collection

  Returns:

  a List of ids that might be what the user was looking for

• getCollectionClass

  public Class<T> getCollectionClass()

  Specified by:

  getCollectionClass in interface IdentifiedCollection<T extends Identified>

  Returns:

  the class from this collections type signature. E.g. if this is Foo extends IdentifiedCollection<Bar> then getCollectionClass() will return a class instance for Bar.

  This method will fail if sub classes of IdentifiedCollection.Base do not declare a type for T parameters have been set.