Package com.exedio.cope

Class Type<T extends Item>

java.lang.Object

com.exedio.cope.Type<T>

All Implemented Interfaces:

AbstractType<T>, Serializable, Comparable<Type<?>>

public final class Type<T extends Item>
extends Object
implements Comparable<Type<?>>, AbstractType<T>

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
<X extends Item> Type<X>	as(Class<X> clazz)
<X extends Item> Type<? extends X>	asExtends(Class<X> clazz)
Type<? extends T>	asSubtype(Type<?> subtype)	Deprecated. Use castTypeExtends(Type) instead
<X extends Item> Type<? super X>	asSuper(Class<X> clazz)
T	cast(Item item)
<X extends Item> Type<X>	castType(Class<X> clazz)	Deprecated. Use as(Class) instead
Type<? extends T>	castTypeExtends(Type<?> subtype)
int	checkCompleteness(Type<? extends T> subType)	Deprecated. Use checkCompletenessL(Type) instead
long	checkCompletenessL(Type<? extends T> subType)
int	checkModificationCounter()	Deprecated. Use checkUpdateCounter() instead
int	checkPrimaryKey()	Deprecated. Use checkSequenceBehindPrimaryKey().isBehindBy() instead
SequenceBehindInfo	checkSequenceBehindPrimaryKey()
int	checkUpdateCounter()	Deprecated. Use checkUpdateCounterL() instead
long	checkUpdateCounterL()
int	compareTo(Type<?> o)
Query<T>	emptyQuery()
static <X extends Item> Type<X>	findByJavaClass(Class<X> javaClass)	Deprecated. Use forClass(Class) instead
static Type<?>	findByJavaClassUnchecked(Class<? extends Item> javaClass)	Deprecated. Use forClassUnchecked(Class) instead
static <X extends Item> Type<X>	forClass(Class<X> javaClass)	Deprecated. Use TypesBound.forClass(Class) instead.
static Type<?>	forClassUnchecked(Class<? extends Item> javaClass)	Deprecated. Use TypesBound.forClassUnchecked(Class) instead.
<A extends Annotation> A	getAnnotation(Class<A> annotationClass)
List<? extends Field<?>>	getAttributes()	Deprecated. Renamed to getFields().
List<? extends CheckConstraint>	getCheckConstraints()
List<? extends CopyConstraint>	getCopyConstraints()
long	getCreateLimit()
List<? extends Field<?>>	getDeclaredAttributes()	Deprecated. Renamed to getDeclaredFields().
List<? extends CheckConstraint>	getDeclaredCheckConstraints()
List<? extends CopyConstraint>	getDeclaredCopyConstraints()
Feature	getDeclaredFeature(String name)
List<? extends Feature>	getDeclaredFeatures()
List<? extends Field<?>>	getDeclaredFields()	Returns the list of persistent fields declared by the this type.
List<ItemField<T>>	getDeclaredReferences()	Returns all ItemFields of the model this type belongs to, which value type equals this type.
List<? extends UniqueConstraint>	getDeclaredUniqueConstraints()
Feature	getFeature(String name)
List<? extends Feature>	getFeatures()
List<? extends Field<?>>	getFields()	Returns the list of accessible persistent fields of this type.
String	getID()	Returns the id of this type.
Class<T>	getJavaClass()
List<String>	getLocalizationKeys()
Model	getModel()
Pattern	getPattern()
String	getPrimaryKeyColumnName()	Deprecated. Use SchemaInfo.getPrimaryKeyColumnName(Type) instead
SequenceInfo	getPrimaryKeyInfo()
List<ItemField<? super T>>	getReferences()	Returns all ItemFields of the model this type belongs to, which value type equals this type or any of it's super types.
List<? extends Type<? extends T>>	getSubtypes()	Returns all types whose super type is this type.
List<? extends Type<? extends T>>	getSubTypes()	Deprecated. Use getSubtypes() instead
List<? extends Type<? extends T>>	getSubtypesTransitively()	Returns a list of all subtypes and all subtypes of the subtypes etc.
List<? extends Type<? extends T>>	getSubTypesTransitively()	Deprecated. Use getSubtypesTransitively() instead
Type<? super T>	getSupertype()	Returns the type representing the superclass of this type's java class.
String	getTableName()	Deprecated. Use SchemaInfo.getTableName(Type) instead
This<T>	getThis()
String	getTypeColumnName()	Deprecated. Use SchemaInfo.getTypeColumnName(Type) instead
List<Type<? extends T>>	getTypesOfInstances()	Returns a list of types, that instances (items) of this type can have.
List<? extends UniqueConstraint>	getUniqueConstraints()
boolean	hasUniqueJavaClass()	Deprecated. Use isBound() instead
boolean	isAbstract()
boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass)
boolean	isAssignableFrom(Type<?> type)
boolean	isBound()	Returns, whether this type bound to it's java class.
boolean	isJavaClassExclusive()	Deprecated. Use isBound() instead
boolean	needsCheckModificationCounter()	Deprecated. Use needsCheckUpdateCounter() instead
boolean	needsCheckUpdateCounter()
T	newItem(SetValue<?>... setValues)
T	newItem(List<SetValue<?>> setValues)
ItemField<T>	newItemField(ItemField.DeletePolicy policy)
Query<T>	newQuery()
Query<T>	newQuery(Condition condition)
Random	random(int seed)
List<T>	search()	Searches for all items of this type.
List<T>	search(Condition condition)	Searches for items of this type, that match the given condition.
List<T>	search(Condition condition, Function<?> orderBy, boolean ascending)	Searches for items of this type, that match the given condition.
T	searchSingleton(Condition condition)	Searches equivalently to search(Condition), but assumes that the condition forces the search result to have at most one element.
T	searchSingletonStrict(Condition condition)	Searches equivalently to search(Condition), but assumes that the condition forces the search result to have exactly one element.
T	searchUnique(Condition condition)	Deprecated. renamed to searchSingleton(Condition).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

as

public <X extends Item> Type<X> as(Class<X> clazz)

See Also:

• asExtends(Class)
• asSuper(Class)
• Class.asSubclass(Class)

asExtends

public <X extends Item> Type<? extends X> asExtends(Class<X> clazz)

See Also:

• as(Class)
• Class.asSubclass(Class)

asSuper

public <X extends Item> Type<? super X> asSuper(Class<X> clazz)

See Also:

• as(Class)

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

See Also:

• Class.isAnnotationPresent(Class)

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationClass)

See Also:

• Class.getAnnotation(Class)

getJavaClass

public Class<T> getJavaClass()

Specified by:

getJavaClass in interface AbstractType<T extends Item>

isBound

public boolean isBound()

Returns, whether this type bound to it's java class. Only such types can be found by TypesBound.forClass(Class) and TypesBound.forClassUnchecked(Class).

getID

public String getID()

Returns the id of this type. Type ids are unique within a model. Use Model.getType(String) for lookup.

getModel

public Model getModel()

getTypesOfInstances

public List<Type<? extends T>> getTypesOfInstances()

Returns a list of types, that instances (items) of this type can have. These are all subtypes of this type, including indirect subtypes, and including this type itself, which are not abstract.

getPrimaryKeyInfo

public SequenceInfo getPrimaryKeyInfo()

checkPrimaryKey

@Deprecated
public int checkPrimaryKey()

Deprecated.

Use checkSequenceBehindPrimaryKey().isBehindBy() instead

Throws:

IllegalStateException - is a transaction is bound to the current thread

checkSequenceBehindPrimaryKey

public SequenceBehindInfo checkSequenceBehindPrimaryKey()

Throws:

IllegalStateException - is a transaction is bound to the current thread

getSupertype

public Type<? super T> getSupertype()

Returns the type representing the superclass of this type's java class. If this type has no super type (i.e. the superclass of this type's java class is Item), then null is returned.

Specified by:

getSupertype in interface AbstractType<T extends Item>

getSubtypes

public List<? extends Type<? extends T>> getSubtypes()

Returns all types whose super type is this type.

Specified by:

getSubtypes in interface AbstractType<T extends Item>

See Also:

• getSubtypesTransitively()

getSubtypesTransitively

public List<? extends Type<? extends T>> getSubtypesTransitively()

Returns a list of all subtypes and all subtypes of the subtypes etc. The result includes this type as well, as any type is its own zeroth-order subtype.

See Also:

• getSubtypes()

isAssignableFrom

public boolean isAssignableFrom(Type<?> type)

castTypeExtends

public Type<? extends T> castTypeExtends(Type<?> subtype)

See Also:

• Class.cast(Object)

isAbstract

public boolean isAbstract()

getThis

public This<T> getThis()

getDeclaredReferences

public List<ItemField<T>> getDeclaredReferences()

Returns all ItemFields of the model this type belongs to, which value type equals this type.

See Also:

• getReferences()

getReferences

public List<ItemField<? super T>> getReferences()

Returns all ItemFields of the model this type belongs to, which value type equals this type or any of it's super types.

See Also:

• getDeclaredReferences()

getDeclaredFields

public List<? extends Field<?>> getDeclaredFields()

Returns the list of persistent fields declared by the this type. This excludes inherited fields. The elements in the list returned are ordered by their occurance in the source code. This method returns an empty list if the type declares no fields.

If you want to get all persistent fields of this type, including fields inherited from super types, use getFields().

Naming of this method is inspired by Java Reflection API method getDeclaredFields.

getFields

public List<? extends Field<?>> getFields()

Returns the list of accessible persistent fields of this type. This includes inherited fields. The elements in the list returned are ordered by their type, with types higher in type hierarchy coming first, and within each type by their occurance in the source code. This method returns an empty list if the type has no accessible fields.

If you want to get persistent fields declared by this type only, excluding fields inherited from super types, use getDeclaredFields().

getDeclaredFeatures

public List<? extends Feature> getDeclaredFeatures()

Specified by:

getDeclaredFeatures in interface AbstractType<T extends Item>

getFeatures

public List<? extends Feature> getFeatures()

Specified by:

getFeatures in interface AbstractType<T extends Item>

getDeclaredFeature

public Feature getDeclaredFeature(String name)

Specified by:

getDeclaredFeature in interface AbstractType<T extends Item>

getFeature

public Feature getFeature(String name)

Specified by:

getFeature in interface AbstractType<T extends Item>

getLocalizationKeys

public List<String> getLocalizationKeys()

Specified by:

getLocalizationKeys in interface AbstractType<T extends Item>

See Also:

• LocalizationKeys

getDeclaredUniqueConstraints

public List<? extends UniqueConstraint> getDeclaredUniqueConstraints()

getUniqueConstraints

public List<? extends UniqueConstraint> getUniqueConstraints()

getDeclaredCheckConstraints

public List<? extends CheckConstraint> getDeclaredCheckConstraints()

getCheckConstraints

public List<? extends CheckConstraint> getCheckConstraints()

getDeclaredCopyConstraints

public List<? extends CopyConstraint> getDeclaredCopyConstraints()

getCopyConstraints

public List<? extends CopyConstraint> getCopyConstraints()

getPattern

public Pattern getPattern()

See Also:

• Pattern.getSourceTypes()

newItemField

public ItemField<T> newItemField(ItemField.DeletePolicy policy)

getCreateLimit

public long getCreateLimit()

See Also:

• CopeCreateLimit

newItem

public T newItem(List<SetValue<?>> setValues)

newItem

public T newItem(SetValue<?>... setValues)

cast

public T cast(Item item)

search

public List<T> search()

Searches for all items of this type.

Returns an unmodifiable collection. Any attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

search

public List<T> search(Condition condition)

Searches for items of this type, that match the given condition.

Returns an unmodifiable collection. Any attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

Parameters:

condition - the condition the searched items must match.

search

public List<T> search(Condition condition,
 Function<?> orderBy,
 boolean ascending)

Searches for items of this type, that match the given condition. The result is sorted by the given function orderBy.

Returns an unmodifiable collection. Any attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

Parameters:

condition - the condition the searched items must match.

ascending - whether the result is sorted ascendingly (true</tt>) or descendingly (<tt>false).

searchSingleton

public T searchSingleton(Condition condition)

Searches equivalently to search(Condition), but assumes that the condition forces the search result to have at most one element.

Returns null, if the search result is empty, returns the only element of the search result, if the result size is exactly one.

Throws:

IllegalArgumentException - if the search result size is greater than one.

See Also:

• Query.searchSingleton()
• searchSingletonStrict(Condition)

searchSingletonStrict

public T searchSingletonStrict(Condition condition)

Searches equivalently to search(Condition), but assumes that the condition forces the search result to have exactly one element.

Returns the only element of the search result, if the result size is exactly one.

Throws:

IllegalArgumentException - if the search result size is not exactly one.

See Also:

• Query.searchSingletonStrict()
• searchSingleton(Condition)

newQuery

public Query<T> newQuery()

newQuery

public Query<T> newQuery(Condition condition)

emptyQuery

public Query<T> emptyQuery()

compareTo

public int compareTo(Type<?> o)

Specified by:

compareTo in interface Comparable<T extends Item>

toString

public String toString()

Overrides:

toString in class Object

checkCompletenessL

public long checkCompletenessL(Type<? extends T> subType)

Parameters:

subType - is allowed any type from getTypesOfInstances(), but not itself.

needsCheckUpdateCounter

public boolean needsCheckUpdateCounter()

checkUpdateCounterL

public long checkUpdateCounterL()

random

public Random random(int seed)

checkUpdateCounter

@Deprecated
public int checkUpdateCounter()

Deprecated.

Use checkUpdateCounterL() instead

checkCompleteness

@Deprecated
public int checkCompleteness(Type<? extends T> subType)

Deprecated.

Use checkCompletenessL(Type) instead

asSubtype

@Deprecated
public Type<? extends T> asSubtype(Type<?> subtype)

Deprecated.

Use castTypeExtends(Type) instead

findByJavaClass

@Deprecated
public static <X extends Item> Type<X> findByJavaClass(Class<X> javaClass)

Deprecated.

Use forClass(Class) instead

findByJavaClassUnchecked

@Deprecated
public static Type<?> findByJavaClassUnchecked(Class<? extends Item> javaClass)

Deprecated.

Use forClassUnchecked(Class) instead

getTableName

@Deprecated
public String getTableName()

Deprecated.

Use SchemaInfo.getTableName(Type) instead

getPrimaryKeyColumnName

@Deprecated
public String getPrimaryKeyColumnName()

Deprecated.

Use SchemaInfo.getPrimaryKeyColumnName(Type) instead

getTypeColumnName

@Deprecated
public String getTypeColumnName()

Deprecated.

Use SchemaInfo.getTypeColumnName(Type) instead

getDeclaredAttributes

@Deprecated
public List<? extends Field<?>> getDeclaredAttributes()

Deprecated.

Renamed to getDeclaredFields().

getAttributes

@Deprecated
public List<? extends Field<?>> getAttributes()

Deprecated.

Renamed to getFields().

searchUnique

@Deprecated
public T searchUnique(Condition condition)

Deprecated.

renamed to searchSingleton(Condition).

castType

@Deprecated
public <X extends Item> Type<X> castType(Class<X> clazz)

Deprecated.

Use as(Class) instead

hasUniqueJavaClass

@Deprecated
public boolean hasUniqueJavaClass()

Deprecated.

Use isBound() instead

getSubTypes

@Deprecated
public List<? extends Type<? extends T>> getSubTypes()

Deprecated.

Use getSubtypes() instead

getSubTypesTransitively

@Deprecated
public List<? extends Type<? extends T>> getSubTypesTransitively()

Deprecated.

Use getSubtypesTransitively() instead

isJavaClassExclusive

@Deprecated
public boolean isJavaClassExclusive()

Deprecated.

Use isBound() instead

forClass

@Deprecated
public static <X extends Item> Type<X> forClass(Class<X> javaClass)

Deprecated.

Use TypesBound.forClass(Class) instead.

forClassUnchecked

@Deprecated
public static Type<?> forClassUnchecked(Class<? extends Item> javaClass)

Deprecated.

Use TypesBound.forClassUnchecked(Class) instead.

needsCheckModificationCounter

@Deprecated
public boolean needsCheckModificationCounter()

Deprecated.

Use needsCheckUpdateCounter() instead

checkModificationCounter

@Deprecated
public int checkModificationCounter()

Deprecated.

Use checkUpdateCounter() instead