Interface IdentifiedCollection<T extends Identified>

Method Details

• add

  void add(T identified) throws ObjectAlreadyExistsException

  Add a pre-constructed identified object to the collection.

  Parameters:

  identified - object to add

  Throws:

  ObjectAlreadyExistsException - if an object already exists with this id

• add

  void add(T identified, Resource source) throws ObjectAlreadyExistsException

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

  Throws:

  ObjectAlreadyExistsException

• add

  void add(String identifier, Resource source, ConstructionCallback<T> callback) throws ObjectAlreadyExistsException

  Add a potentially lazily constructed identified object to this collection.

  Parameters:

  identifier - uniquely identifies the to be constructed object

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

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

  Throws:

  ObjectAlreadyExistsException - if an object with the same identifier already exists in this collection

• addAll

  void addAll(Collection<T> identifieds) throws ObjectAlreadyExistsException

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

  Throws:

  ObjectAlreadyExistsException

• addAll

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

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

  Throws:

  ObjectAlreadyExistsException

• getAll

  List<T> getAll()

  Returns:

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

• getReferences

  List<Reference<T>> getReferences()

  Returns:

  all items in the collection ordered by id

• get

  @Deprecated default T get(String id) throws NoSuchObjectException, FailedObjectException

  Deprecated.

  use get(String, ProblemSink) instead to make sure any warnings get picked up

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

  Parameters:

  id - of item to get.

  Returns:

  item

  Throws:

  NoSuchObjectException - if no item with that id has been registered

  FailedObjectException - if an item was registered, but it failed to be built.

• get

  T get(String id, ProblemSink problemSink) throws NoSuchObjectException, FailedObjectException

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

  Parameters:

  id - of item to get.

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

  Returns:

  item

  Throws:

  NoSuchObjectException - if no item with that id has been registered

  FailedObjectException - if an item was registered, but it failed to be built.

• getOr

  ResultOrProblems<T> getOr(String id)

  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.

• getCollectionClass

  Class<? extends Identified> getCollectionClass()

  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.

• getResult

  Optional<ResultOrProblems<T>> getResult(String id)

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

• getAllProblems

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

  Returns:

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

• containsKey

  boolean containsKey(String id)

  Returns:

  true if collection contains an item with matching id

• remove

  boolean remove(String id)

  Removes an object from the collection

  Returns:

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

• clear

  void clear()

  Remove everything from the collection

• isEmpty

  boolean isEmpty()

  Returns:

  true of this collection contains no entries, failed or otherwise

• getSimilarIds

  List<String> getSimilarIds(String candidate)

  Find possible matches for a failed id lookup.

  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