Package de.cuioss.test.valueobjects.property

Interface PropertyMetadata

All Superinterfaces:

Comparable<PropertyMetadata>

All Known Implementing Classes:

BuilderMetadata, PropertyMetadataImpl

public interface PropertyMetadata
extends Comparable<PropertyMetadata>

Represents runtime information for a certain property. This contains all metadata that may be needed.

Author:

Oliver Wolff

Method Summary

Modifier and Type	Method	Description
AssertionStrategy	getAssertionStrategy()	Defines the the way how to deal with equality regarding PropertySupport.assertValueSet(Object)
CollectionType	getCollectionType()	In case there is a collectionWrapper defined the generated values will implicitly wrapped in the corresponding collection class defined by that wrapper.
de.cuioss.test.generator.TypedGenerator<?>	getGenerator()
String	getName()	Identifies the name of the property
PropertyAccessStrategy	getPropertyAccessStrategy()	Defines the way properties are to be written / read
Class<?>	getPropertyClass()
de.cuioss.tools.property.PropertyMemberInfo	getPropertyMemberInfo()	Indicates the way the corresponding property is subject to the contracts regarding the canonical Object methods like Object.equals(Object), Object.hashCode() and Object.toString() and the Serializable contract.
de.cuioss.tools.property.PropertyReadWrite	getPropertyReadWrite()
boolean	isDefaultValue()
boolean	isRequired()	Indicates that the attribute is required.
Object	next()	Generates a next random value Similar to TypedGenerator.next() but in case there is a getCollectionType() that is not CollectionType.NO_ITERABLE it wraps the content of the contained generator into a the corresponding collectionWrapper, see CollectionType.nextIterable(CollectionGenerator)
Class<?>	resolveActualClass()
de.cuioss.test.generator.impl.CollectionGenerator<?>	resolveCollectionGenerator()

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getName

String getName()

Identifies the name of the property

Returns:

the actual name of the property, must never be null nor empty

getPropertyClass

Class<?> getPropertyClass()

Returns:

the type of the property. This can either be the actual type, in case getCollectionType() is CollectionType.NO_ITERABLE, the component-type in case of CollectionType.ARRAY_MARKER or the type argument for a collection for the other CollectionTypes, see next() and resolveActualClass()

next

Object next()

Generates a next random value Similar to TypedGenerator.next() but in case there is a getCollectionType() that is not CollectionType.NO_ITERABLE it wraps the content of the contained generator into a the corresponding collectionWrapper, see CollectionType.nextIterable(CollectionGenerator)

Returns:

the next generated value

resolveActualClass

Class<?> resolveActualClass()

Returns:

The actual class of the property. PropertyMetadata can always be used directly or the data can be implicitly wrapped into a collection or an array. This method computes the actual class of the property combining both informations

resolveCollectionGenerator

de.cuioss.test.generator.impl.CollectionGenerator<?> resolveCollectionGenerator()

Returns:

a new instance of CollectionGenerator wrapping the contained generator;

getGenerator

de.cuioss.test.generator.TypedGenerator<?> getGenerator()

Returns:

the wrapped TypedGenerator to dynamically create properties.

isDefaultValue

boolean isDefaultValue()

Returns:

boolean indicating whether the attribute defines a default-value. Default is false.

isRequired

boolean isRequired()

Indicates that the attribute is required.

Returns:

boolean indicating whether the attribute is required, defaults to false.

getPropertyAccessStrategy

PropertyAccessStrategy getPropertyAccessStrategy()

Defines the way properties are to be written / read

Returns:

the PropertyAccessStrategy, must never be null, defaults to PropertyAccessStrategy.BEAN_PROPERTY

getCollectionType

CollectionType getCollectionType()

In case there is a collectionWrapper defined the generated values will implicitly wrapped in the corresponding collection class defined by that wrapper.

Returns:

the CollectionType represented by this PropertyMetadata. Must never be null but may be CollectionType.NO_ITERABLE

getPropertyMemberInfo

de.cuioss.tools.property.PropertyMemberInfo getPropertyMemberInfo()

Indicates the way the corresponding property is subject to the contracts regarding the canonical Object methods like Object.equals(Object), Object.hashCode() and Object.toString() and the Serializable contract. The default is PropertyMemberInfo.DEFAULT

Returns:

the PropertyMemberInfo, must never be null

getPropertyReadWrite

de.cuioss.tools.property.PropertyReadWrite getPropertyReadWrite()

Returns:

PropertyReadWrite indicating whether a property can be read or written too, defaults to PropertyReadWrite.READ_WRITE

getAssertionStrategy

AssertionStrategy getAssertionStrategy()

Defines the the way how to deal with equality regarding PropertySupport.assertValueSet(Object)

Returns:

the AssertionStrategy, defaults to AssertionStrategy.DEFAULT