com.agenarisk.api.model.interfaces

Interface IdContainer<E extends Exception>

Type Parameters:

E - the type of Exception thrown on error

All Known Implementing Classes:

Model, Network

public interface IdContainer<E extends Exception>

Classes that have a collection of some identifiable objects that have a unique ID should implement this.

Author:

Eugene Dementiev

Method Summary

Modifier and Type	Method and Description
default <I extends Identifiable> boolean	changeContainedId(I identifiable, String id) Deprecated. For internal use only. You will break referential integrity by using this method directly.
Map<Id,? extends Identifiable>	getIdMap(Class<? extends Identifiable> idClassType) Returns the map of identifiable items based on.
void	throwIdExistsException(String id) Throws an Exception with message e.g.
void	throwOldIdNullException(String id) Throws an Exception with message e.g.

Method Detail

getIdMap

Map<Id,? extends Identifiable> getIdMap(Class<? extends Identifiable> idClassType)
                                 throws E extends Exception

Returns the map of identifiable items based on.

Parameters:

idClassType - the class of identifiable object

Returns:

ID-Identifiable map

Throws:

E - if no collection of type idClassType is registered with the implementing class

E extends Exception

throwIdExistsException

void throwIdExistsException(String id)
                     throws E extends Exception

Throws an Exception with message e.g. "Object with id `id` already exists", localised for the implementing class.

Parameters:

id - ID of the existing object

Throws:

E - when invoked

E extends Exception

throwOldIdNullException

void throwOldIdNullException(String id)
                      throws E extends Exception

Throws an Exception with message e.g. "No such object or old ID is null", localised for the implementing class.

Parameters:

id - ID of the existing object

Throws:

E - when invoked

E extends Exception

changeContainedId

@Deprecated
default <I extends Identifiable> boolean changeContainedId(I identifiable,
                                                                        String id)
                                                                 throws E extends Exception

Deprecated. For internal use only. You will break referential integrity by using this method directly.

Changes the ID of the Identifiable in some mapped reference of the IDContainer.
Does not actually modify Identifiable, which should be done externally.

Type Parameters:

I - Type of the identifiable object

Parameters:

identifiable - the object which ID needs updating

id - new ID

Returns:

true if ID was changed and false if Identifiable is not contained in the map

Throws:

E - if ID already taken

E extends Exception