EntityDictionary (Elide: Core 4.4.1 API)

java.lang.Object
- com.yahoo.elide.core.EntityDictionary

```
public class EntityDictionary
extends Object
```
Entity Dictionary maps JSON API Entity beans to/from Entity type names.

See Also:

Include.type()

Field Summary

Fields
Modifier and Type	Field and Description
`protected CopyOnWriteArrayList<Class<?>>`	`bindEntityRoots`
`protected ConcurrentHashMap<String,Class<?>>`	`bindJsonApiToEntity`
`protected com.google.common.collect.BiMap<String,Class<? extends Check>>`	`checkNames`
`protected ConcurrentHashMap<Class<?>,EntityBinding>`	`entityBindings`
`protected Injector`	`injector`
`protected ConcurrentHashMap<Class<?>,List<Class<?>>>`	`subclassingEntities`

Constructor Summary

Constructors
Constructor and Description
`EntityDictionary(Map<String,Class<? extends Check>> checks)` Instantiate a new EntityDictionary with the provided set of checks.
`EntityDictionary(Map<String,Class<? extends Check>> checks, Injector injector)` Instantiate a new EntityDictionary with the provided set of checks and an injection function.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bindEntity(Class<?> cls)` Add given Entity bean to dictionary.
`<T> void`	`bindInitializer(Initializer<T> initializer, Class<T> cls)` Bind a particular initializer to a class.
`void`	`bindTrigger(Class<?> entityClass, Class<? extends Annotation> annotationClass, LifeCycleHook callback)` Binds a lifecycle hook to a particular entity class.
`void`	`bindTrigger(Class<?> entityClass, Class<? extends Annotation> annotationClass, LifeCycleHook callback, boolean allowMultipleInvocations)` Binds a lifecycle hook to a particular entity class.
`void`	`bindTrigger(Class<?> entityClass, Class<? extends Annotation> annotationClass, String fieldOrMethodName, LifeCycleHook callback)` Binds a lifecycle hook to a particular field or method in an entity.
`boolean`	`cascadeDeletes(Class<?> targetClass, String fieldName)` Returns true if the relationship cascades deletes and false otherwise.
`boolean`	`entityHasChecksForPermission(Class<?> resourceClass, Class<? extends Annotation> annotationClass)` Determine if a given (entity class, permission) pair have any permissions defined.
`static Method`	`findMethod(Class<?> entityClass, String name, Class<?>... paramClass)` Find an arbitrary method.
`AccessibleObject`	`getAccessibleObject(Class<?> targetClass, String fieldName)` Retrieve the accessible object for a field.
`AccessibleObject`	`getAccessibleObject(Object target, String fieldName)` Retrieve the accessible object for a field from a target object.
`javax.persistence.AccessType`	`getAccessType(Class<?> entityClass)` Returns whether the entire entity uses Field or Property level access.
`List<String>`	`getAllFields(Class<?> entityClass)` Get a list of all fields including both relationships and attributes.
`List<String>`	`getAllFields(Object entity)` Get a list of all fields including both relationships and attributes.
`<A extends Annotation> A`	`getAnnotation(Class<?> recordClass, Class<A> annotationClass)` Return annotation from class, parents or package.
`<A extends Annotation> A`	`getAnnotation(PersistentResource record, Class<A> annotationClass)` Return annotation from class, parents or package.
`<A extends Annotation> A`	`getAttributeOrRelationAnnotation(Class<?> entityClass, Class<A> annotationClass, String identifier)` Return a single annotation from field or accessor method.
`<A extends Annotation> A[]`	`getAttributeOrRelationAnnotations(Class<?> entityClass, Class<A> annotationClass, String identifier)` Return multiple annotations from field or accessor method.
`List<String>`	`getAttributes(Class<?> entityClass)` Get the list of attribute names for an entity.
`List<String>`	`getAttributes(Object entity)` Get the list of attribute names for an entity.
`Set<Class<?>>`	`getBindings()` Get all bindings.
`Class<? extends Check>`	`getCheck(String checkIdentifier)` Returns the check mapped to a particular identifier.
`String`	`getCheckIdentifier(Class<? extends Check> checkClass)` Returns the friendly named mapped to this given check.
`Map<String,Class<? extends Check>>`	`getCheckMappings()` Get the check mappings.
`List<String>`	`getElideBoundRelationships(Class<?> entityClass)` Get a list of elide-bound relationships.
`List<String>`	`getElideBoundRelationships(Object entity)` Get a list of elide-bound relationships.
`protected EntityBinding`	`getEntityBinding(Class<?> entityClass)`
`Class<?>`	`getEntityClass(String entityName)` Returns the binding class for a given entity name.
`String`	`getEntityFor(Class<?> entityClass)` Returns the Entity name for a given binding class.
`Set<String>`	`getFieldsOfType(Class<?> targetClass, Class<?> targetType)` Retrieve fields from an object containing a particular type.
`static Annotation`	`getFirstAnnotation(Class<?> entityClass, List<Class<? extends Annotation>> annotationClassList)` Return first matching annotation from class, parents or package.
`String`	`getId(Object value)` Gets id.
`Collection<Annotation>`	`getIdAnnotations(Object value)` Returns annotations applied to the ID field.
`String`	`getIdFieldName(Class<?> entityClass)` Returns the name of the id field.
`Class<?>`	`getIdType(Class<?> entityClass)` Returns type of id field.
`String`	`getJsonAliasFor(Class<?> entityClass)` Returns the Include name for a given binding class.
`String`	`getNameFromAlias(Class<?> entityClass, String alias)` Get the true field/method name from an alias.
`String`	`getNameFromAlias(Object entity, String alias)` Get the true field/method name from an alias.
`Class<?>`	`getParameterizedType(Class<?> entityClass, String identifier)` Retrieve the parameterized type for the given field.
`Class<?>`	`getParameterizedType(Class<?> entityClass, String identifier, int paramIndex)` Retrieve the parameterized type for the given field.
`Class<?>`	`getParameterizedType(Object entity, String identifier)` Retrieve the parameterized type for the given field.
`Class<?>`	`getParameterizedType(Object entity, String identifier, int paramIndex)` Retrieve the parameterized type for the given field.
`org.antlr.v4.runtime.tree.ParseTree`	`getPermissionsForClass(Class<?> resourceClass, Class<? extends Annotation> annotationClass)` Gets the specified permission definition (if any) at the class level.
`org.antlr.v4.runtime.tree.ParseTree`	`getPermissionsForField(Class<?> resourceClass, String field, Class<? extends Annotation> annotationClass)` Gets the specified permission definition (if any) at the class level.
`String`	`getRelationInverse(Class<?> cls, String relation)` If a relationship is bidirectional, returns the name of the peer relationship in the peer entity.
`List<String>`	`getRelationships(Class<?> entityClass)` Get the list of relationship names for an entity.
`List<String>`	`getRelationships(Object entity)` Get the list of relationship names for an entity.
`RelationshipType`	`getRelationshipType(Class<?> cls, String relation)` Get the type of relationship from a relation.
`RelationshipType`	`getRelationshipType(Object entity, String relation)` Get the type of relationship from a relation.
`static String`	`getSimpleName(Class<?> cls)` Cache the simple name of the provided class.
`List<Class<?>>`	`getSubclassingEntities(Class entityClass)` Get a list of inherited entities from a particular entity.
`List<Class<?>>`	`getSubclassingEntities(String entityName)` Get a list of inherited entities from a particular entity.
`List<String>`	`getSubclassingEntityNames(Class entityClass)` Get inherited entity names for a particular entity.
`List<String>`	`getSubclassingEntityNames(String entityName)` Get inherited entity names for a particular entity.
`List<Class<?>>`	`getSuperClassEntities(Class entityClass)` Fetch all entity classes that provided entity inherits from (i.e.
`List<Class<?>>`	`getSuperClassEntities(String entityName)` Fetch all entity classes that the provided entity inherits from (i.e.
`List<String>`	`getSuperClassEntityNames(Class entityClass)` Fetch all entity names that the provided entity inherits from (i.e.
`List<String>`	`getSuperClassEntityNames(String entityName)` Fetch all entity names that the provided entity inherits from (i.e.
`<A extends Annotation> Collection<LifeCycleHook>`	`getTriggers(Class<?> cls, Class<A> annotationClass)`
`<A extends Annotation> Collection<LifeCycleHook>`	`getTriggers(Class<?> cls, Class<A> annotationClass, String fieldName)`
`Class<?>`	`getType(Class<?> entityClass, String identifier)` Get a type for a field on an entity.
`Class<?>`	`getType(Object entity, String identifier)` Get a type for a field on an entity.
`boolean`	`hasBinding(Class<?> cls)` Returns whether or not a class is already bound.
`<T> void`	`initializeEntity(T entity)` Initialize an entity.
`boolean`	`isAttribute(Class<?> entityClass, String attributeName)`
`boolean`	`isComputed(Class<?> entityClass, String fieldName)`
`boolean`	`isMappedInterface(Class<?> interfaceClass)`
`boolean`	`isMethodRequestScopeable(Class<?> entityClass, Method method)` Determine whether or not a method is request scopeable.
`boolean`	`isMethodRequestScopeable(Object entity, Method method)` Determine whether or not a method is request scopeable.
`boolean`	`isRelation(Class<?> entityClass, String relationName)`
`boolean`	`isRoot(Class<?> entityClass)` Is root.
`boolean`	`isShareable(Class<?> entityClass)` Returns whether or not an entity is shareable.
`Class<?>`	`lookupEntityClass(Class<?> objClass)` Follow for this class or super-class for Entity annotation.
`<T> List<T>`	`walkEntityGraph(Set<Class<?>> entities, Function<Class<?>,T> transform)` Walks the entity graph and performs a transform function on each element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - bindJsonApiToEntity
```
protected final ConcurrentHashMap<String,Class<?>> bindJsonApiToEntity
```
  - entityBindings
```
protected final ConcurrentHashMap<Class<?>,EntityBinding> entityBindings
```
  - bindEntityRoots
```
protected final CopyOnWriteArrayList<Class<?>> bindEntityRoots
```
  - subclassingEntities
```
protected final ConcurrentHashMap<Class<?>,List<Class<?>>> subclassingEntities
```
  - checkNames
```
protected final com.google.common.collect.BiMap<String,Class<? extends Check>> checkNames
```
  - injector
```
protected final Injector injector
```
- Constructor Detail
  - EntityDictionary
```
public EntityDictionary(Map<String,Class<? extends Check>> checks)
```
    Instantiate a new EntityDictionary with the provided set of checks. In addition all of the checks in com.yahoo.elide.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))
    
    Parameters:
    
    checks - a map that links the identifiers used in the permission expression strings to their implementing classes
  - EntityDictionary
```
public EntityDictionary(Map<String,Class<? extends Check>> checks,
                        Injector injector)
```
    Instantiate a new EntityDictionary with the provided set of checks and an injection function. In addition all of the checks * in com.yahoo.elide.security.checks.prefab are mapped to Prefab.CONTAINER.CHECK * (e.g. @ReadPermission(expression="Prefab.Role.All") or @ReadPermission(expression="Prefab.Common.UpdateOnCreate"))
    
    Parameters:
    
    checks - a map that links the identifiers used in the permission expression strings to their implementing classes
    
    injector - a function typically associated with a dependency injection framework that will initialize Elide models.
- Method Detail
  - getSimpleName
```
public static String getSimpleName(Class<?> cls)
```
    Cache the simple name of the provided class.
    
    Parameters:
    
    cls - the Class object to be checked
    
    Returns:
    
    simple name
  - findMethod
```
public static Method findMethod(Class<?> entityClass,
                                String name,
                                Class<?>... paramClass)
                         throws NoSuchMethodException
```
    Find an arbitrary method.
    
    Parameters:
    
    entityClass - the entity class
    
    name - the name
    
    paramClass - the param class
    
    Returns:
    
    method method
    
    Throws:
    
    NoSuchMethodException - the no such method exception
  - getEntityBinding
```
protected EntityBinding getEntityBinding(Class<?> entityClass)
```
  - isMappedInterface
```
public boolean isMappedInterface(Class<?> interfaceClass)
```
  - getEntityClass
```
public Class<?> getEntityClass(String entityName)
```
    Returns the binding class for a given entity name.
    
    Parameters:
    
    entityName - entity name
    
    Returns:
    
    binding class
  - getJsonAliasFor
```
public String getJsonAliasFor(Class<?> entityClass)
```
    Returns the Include name for a given binding class.
    
    Parameters:
    
    entityClass - the entity class
    
    Returns:
    
    binding class
    
    See Also:
    
    Include
  - getEntityFor
```
public String getEntityFor(Class<?> entityClass)
```
    Returns the Entity name for a given binding class.
    
    Parameters:
    
    entityClass - the entity class
    
    Returns:
    
    binding class
    
    See Also:
    
    Entity
  - entityHasChecksForPermission
```
public boolean entityHasChecksForPermission(Class<?> resourceClass,
                                            Class<? extends Annotation> annotationClass)
```
    Determine if a given (entity class, permission) pair have any permissions defined.
    
    Parameters:
    
    resourceClass - the entity class
    
    annotationClass - the permission annotation
    
    Returns:
    
    true if that permission is defined anywhere within the class
  - getPermissionsForClass
```
public org.antlr.v4.runtime.tree.ParseTree getPermissionsForClass(Class<?> resourceClass,
                                                                  Class<? extends Annotation> annotationClass)
```
    Gets the specified permission definition (if any) at the class level.
    
    Parameters:
    
    resourceClass - the entity to check
    
    annotationClass - the permission to look for
    
    Returns:
    
    a ParseTree expressing the permissions, if one exists or null if the permission is not specified at a class level
  - getPermissionsForField
```
public org.antlr.v4.runtime.tree.ParseTree getPermissionsForField(Class<?> resourceClass,
                                                                  String field,
                                                                  Class<? extends Annotation> annotationClass)
```
    Gets the specified permission definition (if any) at the class level.
    
    Parameters:
    
    resourceClass - the entity to check
    
    field - the field to inspect
    
    annotationClass - the permission to look for
    
    Returns:
    
    a ParseTree expressing the permissions, if one exists or null if the permission is not specified on that field
  - getCheck
```
public Class<? extends Check> getCheck(String checkIdentifier)
```
    Returns the check mapped to a particular identifier.
    
    Parameters:
    
    checkIdentifier - the name from the expression string
    
    Returns:
    
    the Check mapped to the identifier or null if the given identifer is unmapped
  - getSubclassingEntityNames
```
public List<String> getSubclassingEntityNames(String entityName)
```
    Get inherited entity names for a particular entity.
    
    Parameters:
    
    entityName - Json alias name for entity
    
    Returns:
    
    List of all inherited entity type names
  - getSubclassingEntityNames
```
public List<String> getSubclassingEntityNames(Class entityClass)
```
    Get inherited entity names for a particular entity.
    
    Parameters:
    
    entityClass - Entity class
    
    Returns:
    
    List of all inherited entity type names
  - getSubclassingEntities
```
public List<Class<?>> getSubclassingEntities(String entityName)
```
    Get a list of inherited entities from a particular entity. Namely, the list of entities inheriting from the provided class.
    
    Parameters:
    
    entityName - Json alias name for entity
    
    Returns:
    
    List of all inherited entity types
  - getSubclassingEntities
```
public List<Class<?>> getSubclassingEntities(Class entityClass)
```
    Get a list of inherited entities from a particular entity. Namely, the list of entities inheriting from the provided class.
    
    Parameters:
    
    entityClass - Entity class
    
    Returns:
    
    List of all inherited entity types
  - getSuperClassEntityNames
```
public List<String> getSuperClassEntityNames(String entityName)
```
    Fetch all entity names that the provided entity inherits from (i.e. all superclass entities down to, but excluding Object).
    
    Parameters:
    
    entityName - Json alias name for entity
    
    Returns:
    
    List of all super class entity json names
  - getSuperClassEntityNames
```
public List<String> getSuperClassEntityNames(Class entityClass)
```
    Fetch all entity names that the provided entity inherits from (i.e. all superclass entities down to, but excluding Object).
    
    Parameters:
    
    entityClass - Entity class
    
    Returns:
    
    List of all super class entity json names
  - getSuperClassEntities
```
public List<Class<?>> getSuperClassEntities(String entityName)
```
    Fetch all entity classes that the provided entity inherits from (i.e. all superclass entities down to, but excluding Object).
    
    Parameters:
    
    entityName - Json alias name for entity
    
    Returns:
    
    List of all super class entity classes
  - getSuperClassEntities
```
public List<Class<?>> getSuperClassEntities(Class entityClass)
```
    Fetch all entity classes that provided entity inherits from (i.e. all superclass entities down to, but excluding Object).
    
    Parameters:
    
    entityClass - Entity class
    
    Returns:
    
    List of all super class entity classes
  - getCheckIdentifier
```
public String getCheckIdentifier(Class<? extends Check> checkClass)
```
    Returns the friendly named mapped to this given check.
    
    Parameters:
    
    checkClass - The class to lookup
    
    Returns:
    
    the friendly name of the check.
  - getIdFieldName
```
public String getIdFieldName(Class<?> entityClass)
```
    Returns the name of the id field.
    
    Parameters:
    
    entityClass - Entity class
    
    Returns:
    
    id field name
  - getAccessType
```
public javax.persistence.AccessType getAccessType(Class<?> entityClass)
```
    Returns whether the entire entity uses Field or Property level access.
    
    Parameters:
    
    entityClass - Entity Class
    
    Returns:
    
    The JPA Access Type
  - getBindings
```
public Set<Class<?>> getBindings()
```
    Get all bindings.
    
    Returns:
    
    the bindings
  - getCheckMappings
```
public Map<String,Class<? extends Check>> getCheckMappings()
```
    Get the check mappings.
    
    Returns:
    
    a map of check mappings this dictionary knows about
  - getAttributes
```
public List<String> getAttributes(Class<?> entityClass)
```
    Get the list of attribute names for an entity.
    
    Parameters:
    
    entityClass - entity name
    
    Returns:
    
    List of attribute names for entity
  - getAttributes
```
public List<String> getAttributes(Object entity)
```
    Get the list of attribute names for an entity.
    
    Parameters:
    
    entity - entity instance
    
    Returns:
    
    List of attribute names for entity
  - getRelationships
```
public List<String> getRelationships(Class<?> entityClass)
```
    Get the list of relationship names for an entity.
    
    Parameters:
    
    entityClass - entity name
    
    Returns:
    
    List of relationship names for entity
  - getRelationships
```
public List<String> getRelationships(Object entity)
```
    Get the list of relationship names for an entity.
    
    Parameters:
    
    entity - entity instance
    
    Returns:
    
    List of relationship names for entity
  - getElideBoundRelationships
```
public List<String> getElideBoundRelationships(Class<?> entityClass)
```
    Get a list of elide-bound relationships.
    
    Parameters:
    
    entityClass - Entity class to find relationships for
    
    Returns:
    
    List of elide-bound relationship names.
  - getElideBoundRelationships
```
public List<String> getElideBoundRelationships(Object entity)
```
    Get a list of elide-bound relationships.
    
    Parameters:
    
    entity - Entity instance to find relationships for
    
    Returns:
    
    List of elide-bound relationship names.
  - isMethodRequestScopeable
```
public boolean isMethodRequestScopeable(Object entity,
                                        Method method)
```
    Determine whether or not a method is request scopeable.
    
    Parameters:
    
    entity - Entity instance
    
    method - Method on entity to check
    
    Returns:
    
    True if method accepts a RequestScope, false otherwise.
  - isMethodRequestScopeable
```
public boolean isMethodRequestScopeable(Class<?> entityClass,
                                        Method method)
```
    Determine whether or not a method is request scopeable.
    
    Parameters:
    
    entityClass - Entity to check
    
    method - Method on entity to check
    
    Returns:
    
    True if method accepts a RequestScope, false otherwise.
  - getAllFields
```
public List<String> getAllFields(Class<?> entityClass)
```
    Get a list of all fields including both relationships and attributes.
    
    Parameters:
    
    entityClass - entity name
    
    Returns:
    
    List of all fields.
  - getAllFields
```
public List<String> getAllFields(Object entity)
```
    Get a list of all fields including both relationships and attributes.
    
    Parameters:
    
    entity - entity
    
    Returns:
    
    List of all fields.
  - getRelationshipType
```
public RelationshipType getRelationshipType(Class<?> cls,
                                            String relation)
```
    Get the type of relationship from a relation.
    
    Parameters:
    
    cls - Entity class
    
    relation - Name of relationship field
    
    Returns:
    
    Relationship type. RelationshipType.NONE if is none found.
  - getRelationInverse
```
public String getRelationInverse(Class<?> cls,
                                 String relation)
```
    If a relationship is bidirectional, returns the name of the peer relationship in the peer entity.
    
    Parameters:
    
    cls - the cls
    
    relation - the relation
    
    Returns:
    
    relation inverse
  - getRelationshipType
```
public RelationshipType getRelationshipType(Object entity,
                                            String relation)
```
    Get the type of relationship from a relation.
    
    Parameters:
    
    entity - Entity instance
    
    relation - Name of relationship field
    
    Returns:
    
    Relationship type. RelationshipType.NONE if is none found.
  - getType
```
public Class<?> getType(Class<?> entityClass,
                        String identifier)
```
    Get a type for a field on an entity.
    
    Parameters:
    
    entityClass - Entity class
    
    identifier - Field to lookup type
    
    Returns:
    
    Type of entity
  - getType
```
public Class<?> getType(Object entity,
                        String identifier)
```
    Get a type for a field on an entity.
    
    Parameters:
    
    entity - Entity instance
    
    identifier - Field to lookup type
    
    Returns:
    
    Type of entity
  - getParameterizedType
```
public Class<?> getParameterizedType(Class<?> entityClass,
                                     String identifier)
```
    Retrieve the parameterized type for the given field.
    
    Parameters:
    
    entityClass - the entity class
    
    identifier - the identifier
    
    Returns:
    
    Entity type for field otherwise null.
  - getParameterizedType
```
public Class<?> getParameterizedType(Class<?> entityClass,
                                     String identifier,
                                     int paramIndex)
```
    Retrieve the parameterized type for the given field.
    
    Parameters:
    
    entityClass - the entity class
    
    identifier - the identifier
    
    paramIndex - the index of the parameterization
    
    Returns:
    
    Entity type for field otherwise null.
  - getParameterizedType
```
public Class<?> getParameterizedType(Object entity,
                                     String identifier)
```
    Retrieve the parameterized type for the given field.
    
    Parameters:
    
    entity - Entity instance
    
    identifier - Field to lookup
    
    Returns:
    
    Entity type for field otherwise null.
  - getParameterizedType
```
public Class<?> getParameterizedType(Object entity,
                                     String identifier,
                                     int paramIndex)
```
    Retrieve the parameterized type for the given field.
    
    Parameters:
    
    entity - Entity instance
    
    identifier - Field to lookup
    
    paramIndex - the index of the parameterization
    
    Returns:
    
    Entity type for field otherwise null.
  - getNameFromAlias
```
public String getNameFromAlias(Class<?> entityClass,
                               String alias)
```
    Get the true field/method name from an alias.
    
    Parameters:
    
    entityClass - Entity name
    
    alias - Alias to convert
    
    Returns:
    
    Real field/method name as a string. null if not found.
  - getNameFromAlias
```
public String getNameFromAlias(Object entity,
                               String alias)
```
    Get the true field/method name from an alias.
    
    Parameters:
    
    entity - Entity instance
    
    alias - Alias to convert
    
    Returns:
    
    Real field/method name as a string. null if not found.
  - initializeEntity
```
public <T> void initializeEntity(T entity)
```
    Initialize an entity.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    entity - Entity to initialize
  - bindInitializer
```
public <T> void bindInitializer(Initializer<T> initializer,
                                Class<T> cls)
```
    Bind a particular initializer to a class.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    initializer - Initializer to use for class
    
    cls - Class to bind initialization
  - isShareable
```
public boolean isShareable(Class<?> entityClass)
```
    Returns whether or not an entity is shareable.
    
    Parameters:
    
    entityClass - the entity type to check for the shareable permissions
    
    Returns:
    
    true if entityClass is shareable. False otherwise.
  - bindEntity
```
public void bindEntity(Class<?> cls)
```
    Add given Entity bean to dictionary.
    
    Parameters:
    
    cls - Entity bean class
  - getAnnotation
```
public <A extends Annotation> A getAnnotation(PersistentResource record,
                                              Class<A> annotationClass)
```
    Return annotation from class, parents or package.
    
    Type Parameters:
    
    A - genericClass
    
    Parameters:
    
    record - the record
    
    annotationClass - the annotation class
    
    Returns:
    
    the annotation
  - getAnnotation
```
public <A extends Annotation> A getAnnotation(Class<?> recordClass,
                                              Class<A> annotationClass)
```
    Return annotation from class, parents or package.
    
    Type Parameters:
    
    A - genericClass
    
    Parameters:
    
    recordClass - the record class
    
    annotationClass - the annotation class
    
    Returns:
    
    the annotation
  - getTriggers
```
public <A extends Annotation> Collection<LifeCycleHook> getTriggers(Class<?> cls,
                                                                    Class<A> annotationClass,
                                                                    String fieldName)
```
  - getTriggers
```
public <A extends Annotation> Collection<LifeCycleHook> getTriggers(Class<?> cls,
                                                                    Class<A> annotationClass)
```
  - getAttributeOrRelationAnnotation
```
public <A extends Annotation> A getAttributeOrRelationAnnotation(Class<?> entityClass,
                                                                 Class<A> annotationClass,
                                                                 String identifier)
```
    Return a single annotation from field or accessor method.
    
    Type Parameters:
    
    A - genericClass
    
    Parameters:
    
    entityClass - the entity class
    
    annotationClass - given annotation type
    
    identifier - the identifier
    
    Returns:
    
    annotation found
  - getAttributeOrRelationAnnotations
```
public <A extends Annotation> A[] getAttributeOrRelationAnnotations(Class<?> entityClass,
                                                                    Class<A> annotationClass,
                                                                    String identifier)
```
    Return multiple annotations from field or accessor method.
    
    Type Parameters:
    
    A - the type parameter
    
    Parameters:
    
    entityClass - the entity class
    
    annotationClass - given annotation type
    
    identifier - the identifier
    
    Returns:
    
    annotation found or null if none found
  - getFirstAnnotation
```
public static Annotation getFirstAnnotation(Class<?> entityClass,
                                            List<Class<? extends Annotation>> annotationClassList)
```
    Return first matching annotation from class, parents or package.
    
    Parameters:
    
    entityClass - Entity class type
    
    annotationClassList - List of sought annotations
    
    Returns:
    
    annotation found
  - isRoot
```
public boolean isRoot(Class<?> entityClass)
```
    Is root.
    
    Parameters:
    
    entityClass - the entity class
    
    Returns:
    
    the boolean
  - getId
```
public String getId(Object value)
```
    Gets id.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the id
  - getIdType
```
public Class<?> getIdType(Class<?> entityClass)
```
    Returns type of id field.
    
    Parameters:
    
    entityClass - the entity class
    
    Returns:
    
    ID type
  - getIdAnnotations
```
public Collection<Annotation> getIdAnnotations(Object value)
```
    Returns annotations applied to the ID field.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    Collection of Annotations
  - lookupEntityClass
```
public Class<?> lookupEntityClass(Class<?> objClass)
```
    Follow for this class or super-class for Entity annotation.
    
    Parameters:
    
    objClass - provided class
    
    Returns:
    
    class with Entity annotation
  - getAccessibleObject
```
public AccessibleObject getAccessibleObject(Object target,
                                            String fieldName)
```
    Retrieve the accessible object for a field from a target object.
    
    Parameters:
    
    target - the object to get
    
    fieldName - the field name to get or invoke equivalent get method
    
    Returns:
    
    the value
  - isComputed
```
public boolean isComputed(Class<?> entityClass,
                          String fieldName)
```
  - getAccessibleObject
```
public AccessibleObject getAccessibleObject(Class<?> targetClass,
                                            String fieldName)
```
    Retrieve the accessible object for a field.
    
    Parameters:
    
    targetClass - the object to get
    
    fieldName - the field name to get or invoke equivalent get method
    
    Returns:
    
    the value
  - getFieldsOfType
```
public Set<String> getFieldsOfType(Class<?> targetClass,
                                   Class<?> targetType)
```
    Retrieve fields from an object containing a particular type.
    
    Parameters:
    
    targetClass - Class to search for fields
    
    targetType - Type of fields to find
    
    Returns:
    
    Set containing field names
  - isRelation
```
public boolean isRelation(Class<?> entityClass,
                          String relationName)
```
  - isAttribute
```
public boolean isAttribute(Class<?> entityClass,
                           String attributeName)
```
  - bindTrigger
```
public void bindTrigger(Class<?> entityClass,
                        Class<? extends Annotation> annotationClass,
                        String fieldOrMethodName,
                        LifeCycleHook callback)
```
    Binds a lifecycle hook to a particular field or method in an entity. The hook will be called a single time per request per field READ, CREATE, or UPDATE.
    
    Parameters:
    
    entityClass - The entity that triggers the lifecycle hook.
    
    annotationClass - (OnReadPostCommit, OnUpdatePreSecurity, etc)
    
    fieldOrMethodName - The name of the field or method
    
    callback - The callback function to invoke.
  - bindTrigger
```
public void bindTrigger(Class<?> entityClass,
                        Class<? extends Annotation> annotationClass,
                        LifeCycleHook callback,
                        boolean allowMultipleInvocations)
```
    Binds a lifecycle hook to a particular entity class. The hook will either be called: - A single time single time per request per class READ, CREATE, UPDATE, or DELETE. - Multiple times per request per field READ, CREATE, or UPDATE. The behavior is determined by the value of the allowMultipleInvocations flag.
    
    Parameters:
    
    entityClass - The entity that triggers the lifecycle hook.
    
    annotationClass - (OnReadPostCommit, OnUpdatePreSecurity, etc)
    
    callback - The callback function to invoke.
    
    allowMultipleInvocations - Should the same life cycle hook be invoked multiple times for multiple CRUD actions on the same model.
  - bindTrigger
```
public void bindTrigger(Class<?> entityClass,
                        Class<? extends Annotation> annotationClass,
                        LifeCycleHook callback)
```
    Binds a lifecycle hook to a particular entity class. The hook will be called a single time per request per class READ, CREATE, UPDATE, or DELETE.
    
    Parameters:
    
    entityClass - The entity that triggers the lifecycle hook.
    
    annotationClass - (OnReadPostCommit, OnUpdatePreSecurity, etc)
    
    callback - The callback function to invoke.
  - cascadeDeletes
```
public boolean cascadeDeletes(Class<?> targetClass,
                              String fieldName)
```
    Returns true if the relationship cascades deletes and false otherwise.
    
    Parameters:
    
    targetClass - The class which owns the relationship.
    
    fieldName - The relationship
    
    Returns:
    
    true or false
  - walkEntityGraph
```
public <T> List<T> walkEntityGraph(Set<Class<?>> entities,
                                   Function<Class<?>,T> transform)
```
    Walks the entity graph and performs a transform function on each element.
    
    Type Parameters:
    
    T - The result type.
    
    Parameters:
    
    entities - The roots of the entity graph.
    
    transform - The function to transform each entity class into a result.
    
    Returns:
    
    The collection of results.
  - hasBinding
```
public boolean hasBinding(Class<?> cls)
```
    Returns whether or not a class is already bound.
    
    Parameters:
    
    cls -
    
    Returns:
    
    true if the class is bound. False otherwise.

Class EntityDictionary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bindJsonApiToEntity

entityBindings

bindEntityRoots

subclassingEntities

checkNames

injector

Constructor Detail

EntityDictionary

EntityDictionary

Method Detail

getSimpleName

findMethod

getEntityBinding

isMappedInterface

getEntityClass

getJsonAliasFor

getEntityFor

entityHasChecksForPermission

getPermissionsForClass

getPermissionsForField

getCheck

getSubclassingEntityNames

getSubclassingEntityNames

getSubclassingEntities

getSubclassingEntities

getSuperClassEntityNames

getSuperClassEntityNames

getSuperClassEntities

getSuperClassEntities

getCheckIdentifier

getIdFieldName

getAccessType

getBindings

getCheckMappings

getAttributes

getAttributes

getRelationships

getRelationships

getElideBoundRelationships

getElideBoundRelationships

isMethodRequestScopeable

isMethodRequestScopeable

getAllFields

getAllFields

getRelationshipType

getRelationInverse

getRelationshipType

getType

getType

getParameterizedType

getParameterizedType

getParameterizedType

getParameterizedType

getNameFromAlias

getNameFromAlias

initializeEntity

bindInitializer

isShareable

bindEntity

getAnnotation

getAnnotation

getTriggers

getTriggers

getAttributeOrRelationAnnotation

getAttributeOrRelationAnnotations

getFirstAnnotation

isRoot

getId

getIdType

getIdAnnotations

lookupEntityClass

getAccessibleObject

isComputed

getAccessibleObject