You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by gp...@apache.org on 2010/10/26 18:49:06 UTC
svn commit: r1027642 [2/2] - in
/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator:
core/el/ core/factory/ core/initializer/component/
core/initializer/configuration/ core/interceptor/ core/mapper/ core/metad...
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/proxy/ProxyHelper.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/proxy/ProxyHelper.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/proxy/ProxyHelper.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/proxy/ProxyHelper.java Tue Oct 26 16:49:05 2010
@@ -22,8 +22,8 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.UsageCategory;
/**
- * Allows to have a helper object that deals with proxies, like CGLIB proxies, created for some objects. There are
- * various locations where we need to know the base class or name of a prpoxy instance.
+ * Pluggable helper which handles proxied instances correctly.
+ * (The default implementation supports cglib and javassist
*
* @author Gerhard Petracek
* @since x.x.3
@@ -32,52 +32,55 @@ import org.apache.myfaces.extensions.val
public interface ProxyHelper
{
/**
- * Returns the Class metadata of the proxy class. When the parameter isn't a proxy, it returns the parameter value.
+ * Returns the original class for the given class which might be the class of a proxied instance.
*
* @param currentClass class of proxy instance or any regular class.
- * @return base class for which the proxy was created.
+ * @return the class of the original (unproxied) instance or the parameter itself
*/
Class getUnproxiedClass(Class currentClass);
/**
- * Returns the Class metadata of the proxy class casted to a certain targetType. There is no check to see if the
- * base class is actually assignable to the targetType.
+ * In addition to ProxyHelper#getUnproxiedClass(java.lang.Class) it casts to the given type.
* @see ProxyHelper#getUnproxiedClass(java.lang.Class)
*
* @param currentClass class of proxy instance or any regular class.
* @param targetType target class type
* @param <T> Type declaration for generics.
- * @return base class for which the proxy was created.
+ * @return the class of the original (unproxied) instance or the parameter itself
*/
<T> Class<T> getUnproxiedClass(Class currentClass, Class<T> targetType);
/**
- * Returns the class name of the base class of the proxy.
+ * Returns the original fully qualified class-name for
+ * the given class which might be the class of a proxied instance.
+ *
* @param proxiedClass class of proxy instance or any regular class.
- * @return class name of base class for which the proxy was created.
+ * @return the class-name of the original (unproxied) instance or the name of the parameter itself
*/
String getNameOfClass(Class proxiedClass);
/**
- * Returns the class name of the base class of the proxy instance.
+ * Returns the original fully qualified class-name for
+ * the given object which might be a proxied instance.
+ *
* @param proxiedObject proxy instance or any regular object.
- * @return class name of base class for which the proxy was created.
+ * @return the class-name of the original (unproxied) instance or the name of the parameter itself
*/
String getClassNameOfObject(Object proxiedObject);
/**
- * Checks if the class is a proxy class.
+ * Checks if the given class is a class of a proxied instance.
*
* @param currentClass proxy class to check.
- * @return is it a proxy class or regular class.
+ * @return true if the given class is a class of a proxied instance
*/
boolean isProxiedClass(Class currentClass);
/**
- * Checks if this object is a proxy.
+ * Checks if the given instance is proxied.
*
* @param proxiedObject object to check.
- * @return is it a proxy or regular object.
+ * @return true if the given object is a proxied instance
*/
boolean isProxiedObject(Object proxiedObject);
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/recorder/ProcessedInformationRecorder.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/recorder/ProcessedInformationRecorder.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/recorder/ProcessedInformationRecorder.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/recorder/ProcessedInformationRecorder.java Tue Oct 26 16:49:05 2010
@@ -33,9 +33,9 @@ import javax.faces.component.UIComponent
public interface ProcessedInformationRecorder
{
/**
- * Allows to store the converted value for the uiComponent.
+ * Allows to store the converted value of the given uiComponent.
*
- * @param uiComponent JSF UI Component
+ * @param uiComponent current component
* @param value Converted user value.
*/
void recordUserInput(UIComponent uiComponent, Object value);
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipAfterInterceptorsException.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipAfterInterceptorsException.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipAfterInterceptorsException.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipAfterInterceptorsException.java Tue Oct 26 16:49:05 2010
@@ -22,8 +22,9 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.UsageInformation;
/**
- * Marker exception that can be thrown by the rendererInterceptor methods to stop the execution of all after defined
- * methods of the interceptor.
+ * Marker exception that can be thrown by an after-method
+ * ({@link org.apache.myfaces.extensions.validator.core.interceptor.RendererInterceptor})
+ * to stop the execution of the subsequent interceptors.
*
* @author Gerhard Petracek
* @since 1.x.1
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipBeforeInterceptorsException.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipBeforeInterceptorsException.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipBeforeInterceptorsException.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipBeforeInterceptorsException.java Tue Oct 26 16:49:05 2010
@@ -22,8 +22,9 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.UsageInformation;
/**
- * Marker exception that can be thrown by the rendererInterceptor methods to stop the execution of all before defined
- * methods of the interceptor.
+ * Marker exception that can be thrown by a before-method
+ * ({@link org.apache.myfaces.extensions.validator.core.interceptor.RendererInterceptor})
+ * to stop the execution of the subsequent interceptors.
*
* @author Gerhard Petracek
* @since 1.x.1
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipRendererDelegationException.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipRendererDelegationException.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipRendererDelegationException.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/renderkit/exception/SkipRendererDelegationException.java Tue Oct 26 16:49:05 2010
@@ -23,8 +23,9 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.UsageInformation;
/**
- * Exception that can be thrown by RendererInterceptor implementations to indicate that the execution of the intercepted
- * renderer method is aborted.
+ * Exception that can be thrown by a
+ * ({@link org.apache.myfaces.extensions.validator.core.interceptor.RendererInterceptor})
+ * to skip the invocation of the intercepted renderer method.
*
* @author Gerhard Petracek
* @since 1.x.1
@@ -38,18 +39,16 @@ public class SkipRendererDelegationExcep
private static final long serialVersionUID = 2343074077532915722L;
/**
- * Initialization of empty Exception object with the skipOtherInterceptors property set to false. When exception is
- * thrown in the getConvertedValue method, the converted value can't be altered.
+ * Constructor for creating an exception which doesn't skip the invocation of the other interceptors.
*/
public SkipRendererDelegationException()
{
}
/**
- * Initialization of an empty Exception object where we can specify it other interceptors should be skipped or not.
- * When exception is thrown in the getConvertedValue method, the converted value can't be altered.
+ * Constructor for creating an exception which might skip the invocation of the other interceptors.
*
- * @param skipOtherInterceptors should other interceptors be skipped.
+ * @param skipOtherInterceptors signals if the other interceptors should be skipped.
*/
public SkipRendererDelegationException(boolean skipOtherInterceptors)
{
@@ -57,11 +56,11 @@ public class SkipRendererDelegationExcep
}
/**
- * Initialization of an Exception where we supply the interceptor where it went wrong. This interceptor is then
- * consulted for the final value of the converted value.
+ * Constructor for creating an exception which doesn't skip the invocation of the other interceptors.
+ * Furthermore, it allows to get information about the {@link RendererInterceptor} which threw the exception.
*
- * @param skipOtherInterceptors should other interceptors be skipped.
- * @param rendererInterceptor interceptor that is the cause of this exception.
+ * @param skipOtherInterceptors signals if the other interceptors should be skipped.
+ * @param rendererInterceptor interceptor which threw this exception.
*/
public SkipRendererDelegationException(boolean skipOtherInterceptors, RendererInterceptor rendererInterceptor)
{
@@ -80,7 +79,7 @@ public class SkipRendererDelegationExcep
}
/**
- * Gets the additional information.
+ * Returns the additional information.
*
* @return the additional information.
*/
@@ -90,9 +89,9 @@ public class SkipRendererDelegationExcep
}
/**
- * Should other interceptors be skipped according to the info supplied at the time of creation of the exception.
+ * Signals if the subsequent interceptors should be skipped.
*
- * @return should other interceptors be skipped.
+ * @return true if the subsequent interceptors should be skipped, false otherwise
*/
public boolean isSkipOtherInterceptors()
{
@@ -100,11 +99,10 @@ public class SkipRendererDelegationExcep
}
/**
- * When a rendererInterceptor is supplied at the time of the creation, it is consulted about the value the ExtVal
- * system should return as converted value. Otherwise, it is the value of the parameter.
+ * Returns the value which should be used as result (if the intercepted method has to provide a return value).
*
- * @param currentReturnValue Converted value defined by the JSF system.
- * @return Converted value that we should return.
+ * @param currentReturnValue the original converted value
+ * @return value that should be returned as converted value.
*/
public Object getReturnValueOnException(Object currentReturnValue)
{
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/MetaDataStorageFilter.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/MetaDataStorageFilter.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/MetaDataStorageFilter.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/MetaDataStorageFilter.java Tue Oct 26 16:49:05 2010
@@ -23,13 +23,9 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.core.property.PropertyInformation;
/**
- * Allows a filtering of the MetaDataEntry's which are stored in the MetaDataStorage by the default implementation
- * (DefaultMetaDataStorage). <br/>
- * The storage of the metaData is done as part of the extraction of them from the component (see method extract of
- * DefaultComponentMetaDataExtract). So this extraction can return less information then which is available on the
- * property due to this filtering.
+ * Allows filtering e.g. {@link org.apache.myfaces.extensions.validator.core.metadata.MetaDataEntry MetaDataEntries}.
+ * So it's possible to add/remove entries which should or shouldn't be used.
*
- * @see org.apache.myfaces.extensions.validator.core.storage.DefaultMetaDataStorage
* @author Gerhard Petracek
* @since x.x.3
*/
@@ -37,10 +33,10 @@ import org.apache.myfaces.extensions.val
public interface MetaDataStorageFilter
{
/**
- * Method should filter the metaDataEntry's of the propertyInformation which are not needed by the validation
- * process.
- * @param propertyInformation information about constraints on the property and contains the list of
- * MetaDataEntry's.
+ * Allows to manipulate the given information which will be used e.g. for
+ * the validation and component initialization process.
+ *
+ * @param propertyInformation information about the current property
*/
void filter(PropertyInformation propertyInformation);
}
\ No newline at end of file
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManager.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManager.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManager.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManager.java Tue Oct 26 16:49:05 2010
@@ -22,9 +22,8 @@ import org.apache.myfaces.extensions.val
import static org.apache.myfaces.extensions.validator.internal.UsageCategory.API;
/**
- * Manager to create and reset specific storage implementations. The storageManager is responsible for creating and
- * resetting a certain storage. A manager can be responsible for multiple storages an d they are identified by a key
- * which is a string value.
+ * Storage managers are responsible to create and reset specific storage implementations depending on the scope.
+ * A manager can be responsible for multiple (named) storages.
*
* @param <T> Type of Storage that is maintained by the storageManager.
*
@@ -35,18 +34,19 @@ import static org.apache.myfaces.extensi
public interface StorageManager<T>
{
/**
- * Create, or retrieve a previously created instance, of the storage for the specified key.
+ * Creates and scope or retrieve a previously created instance, of the storage for the given key.
*
- * @param key The type of storage that needs to be created
- * @return The storage associated with the key or null when key is unknown to the storageManager.
+ * @param key The key for a storage that needs to be created
+ * @return The storage associated with the key or null if the key is unknown to the storageManager.
*/
T create(String key);
/**
- * Resets the storage identified with the specified key. When the storage isn't created yet or the key is unknown
+ * Resets the storage linked to the given key.
+ * If the storage isn't created yet or the key is unknown
* for the storageManager, nothing is performed and no exception is thrown.
*
- * @param key The type of storage that needs to be reset.
+ * @param key The key for a storage that needs to be resetted
*/
void reset(String key);
}
\ No newline at end of file
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManagerHolder.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManagerHolder.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManagerHolder.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManagerHolder.java Tue Oct 26 16:49:05 2010
@@ -25,6 +25,7 @@ import static org.apache.myfaces.extensi
* Interface to manage storage-manager instances.
*
* @see org.apache.myfaces.extensions.validator.core.storage.StorageManager
+ *
* @author Gerhard Petracek
* @since x.x.3
*/
@@ -32,20 +33,20 @@ import static org.apache.myfaces.extensi
public interface StorageManagerHolder
{
/**
- * Define the storage manager for the specified type.
- * @param type The identification for the storage manager, by convention it is the object type managed by the
- * storageManager.
+ * Define the storage manager for the given type.
+ *
+ * @param type The identification for the storage manager, usually it is the storage-class
* @param storageManager The storageManager to use.
- * @param override if true, the previous defined storageManager is no longer used. If false, the specified
- * storage manager is only used when no manager was defined.
+ * @param override use true to replace an existing storageManager and
+ * false to use the manager only if there isn't an existing manager for the given type
*/
void setStorageManager(Class type, StorageManager storageManager, boolean override);
/**
- * Retrieves the storageManager for the specified type.
- * @param type The identification for the storage manager, by convention it is the object type managed by the
- * storageManager.
- * @return the storageManager specified for the type or null if no manager specified for the type.
+ * Returns the storageManager for the given type.
+ *
+ * @param type The identification for the storage manager, usually it is the storage-class
+ * @return the storageManager for the given type or null
*/
StorageManager getStorageManager(Class type);
}
\ No newline at end of file
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/ViolationSeverityInterpreterStorage.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/ViolationSeverityInterpreterStorage.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/ViolationSeverityInterpreterStorage.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/ViolationSeverityInterpreterStorage.java Tue Oct 26 16:49:05 2010
@@ -23,11 +23,9 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.core.validation.parameter.ViolationSeverityInterpreter;
/**
- * Suggested interface for a violation-severity-interpreter storage.
+ * Interface for a {@link ViolationSeverityInterpreter} storage.
* Used by add-ons to change the interpreter for the current request.
- * Behaves like a singleton/Application scoped object and the default for this interface is
- * DefaultViolationSeverityInterpreterStorage.
- *
+ *
* @author Gerhard Petracek
* @since x.x.3
*/
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/NullValueAwareValidationStrategy.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/NullValueAwareValidationStrategy.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/NullValueAwareValidationStrategy.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/NullValueAwareValidationStrategy.java Tue Oct 26 16:49:05 2010
@@ -28,9 +28,9 @@ import java.lang.annotation.Documented;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
- * Marker annotation to indicate that the strategy can handle null values as values to validate. This was introduced
- * to have the correct behaviour in relation to the parameter
- * javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL.
+ * Marker annotation to indicate that the strategy can handle null values as values to validate.
+ * If a {@link org.apache.myfaces.extensions.validator.core.validation.strategy.ValidationStrategy} is NOT annotated
+ * with this marker, it doesn't have to care about null values.
*
* @author Gerhard Petracek
* @since x.x.3
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/SkipValidationEvaluator.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/SkipValidationEvaluator.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/SkipValidationEvaluator.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/SkipValidationEvaluator.java Tue Oct 26 16:49:05 2010
@@ -27,10 +27,8 @@ import javax.faces.context.FacesContext;
import javax.faces.component.UIComponent;
/**
- * Evaluator that defines if a certain validation needs to be skipped for the field component. When the property
- * module is added to the project, the default evaluator is
- * {@code org.apache.myfaces.extensions.validator.PropertyValidationSkipValidationEvaluator}
- *
+ * Evaluator which checks if the validation process should be skipped for the given component.
+ *
* @author Gerhard Petracek
* @since x.x.3
*/
@@ -38,14 +36,16 @@ import javax.faces.component.UIComponent
public interface SkipValidationEvaluator
{
/**
- * Is the specific validation, specified by the parameter validationStrategy, skipped for the uiComponent.
- * Additional information about the validation can be found in the entry parameter.
+ * Checks if the validation process should be skipped for the given component.
+ *
* @param facesContext The JSF Context
* @param uiComponent The component for which the validation should happen.
- * @param validationStrategy The validation that needs to be performed
- * @param entry Additional information about the validation
- * @return true when validation doesn't need to be performed.
+ * @param validationStrategy The validation-strategy which is responsible for validating the given entry
+ * @param entry the {@link MetaDataEntry} in question
+ * @return true if the validation process should be skipped, false otherwise
*/
- boolean skipValidation(FacesContext facesContext, UIComponent uiComponent,
- ValidationStrategy validationStrategy, MetaDataEntry entry);
+ boolean skipValidation(FacesContext facesContext,
+ UIComponent uiComponent,
+ ValidationStrategy validationStrategy,
+ MetaDataEntry entry);
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetProperty.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetProperty.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetProperty.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetProperty.java Tue Oct 26 16:49:05 2010
@@ -29,10 +29,11 @@ import java.lang.annotation.Documented;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
- * To specify which property needs to be used that is the source of the ExtVal constraints. The property is searched
- * in the class defined in {@link org.apache.myfaces.extensions.validator.core.validation.ConstraintSource}. <br/>
- * If needed, this annotation can be replaced by a customer defined one if one likes to have independence of ExtVal in
- * model classes, see targetPropertyAnnotation in ExtValCoreConfiguration.
+ * To specify which property should be used as constraint source (instead of the default naming convention).
+ *
+ * If needed, this annotation can be replaced by a custom annotation to keep the implementation independent of ExtVal.
+ * (see targetPropertyAnnotation in ExtValCoreConfiguration)
+ *
* @see org.apache.myfaces.extensions.validator.core.validation.ConstraintSource
*
* @author Gerhard Petracek
@@ -45,8 +46,9 @@ import static java.lang.annotation.Reten
public @interface TargetProperty
{
/**
- * property name to be used.
- * @return property to search in target class of ExtVal Constraints.
+ * property-name available at the target which should be used as constraint source
+ *
+ * @return property-name which has to exist at the target-cass
*/
String value();
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetPropertyId.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetPropertyId.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetPropertyId.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/TargetPropertyId.java Tue Oct 26 16:49:05 2010
@@ -30,11 +30,15 @@ import java.lang.annotation.Annotation;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
- * Indication of what annotation has to be searched in the class that is the source of the ExtVal constraints. <br/>
- * If needed, this annotation can be replaced by a customer defined one if one likes to have independence of ExtVal in
- * model classes, see targetPropertyIdAnnotation in ExtValCoreConfiguration.
+ * To specify which property should be used as constraint source (instead of the default naming convention).
+ * Compared to {@link TargetProperty} this annotation allows to use custom annotations to mark the target
+ * (instead of the name of the property).
+ *
+ * If needed, this annotation can be replaced by a custom annotation to keep the implementation independent of ExtVal.
+ * (see targetPropertyIdAnnotation in ExtValCoreConfiguration)
+ *
* @see org.apache.myfaces.extensions.validator.core.validation.ConstraintSource
- *
+ *
* @author Gerhard Petracek
* @since r4
*/
@@ -45,8 +49,10 @@ import static java.lang.annotation.Reten
public @interface TargetPropertyId
{
/**
- * Annotation to be searched.
- * @return annotation to search in target class of ExtVal Constraints.
+ * class of an annotation which has to be available at a property of the target as a type-safe marker.
+ * the annotation marks the property which should be used as constraint-source.
+ *
+ * @return class of an annotation which has to exist at a property of the target-cass
*/
Class<? extends Annotation> value();
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/exception/RequiredValidatorException.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/exception/RequiredValidatorException.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/exception/RequiredValidatorException.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/exception/RequiredValidatorException.java Tue Oct 26 16:49:05 2010
@@ -25,8 +25,8 @@ import javax.faces.validator.ValidatorEx
import javax.faces.application.FacesMessage;
/**
- * To handle special cases in ValidationExceptionInterceptors. It acts just like a regular ValidatorException except
- * that code can detect that the validation problem occurred related to a required field.
+ * JSF components allow different inline-messages for required violations and all other types of validation failures.
+ * This exception is used to determine if the special required error message should be used.
*
* @author Gerhard Petracek
* @since x.x.3
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/message/resolver/MessageResolver.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/message/resolver/MessageResolver.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/message/resolver/MessageResolver.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/message/resolver/MessageResolver.java Tue Oct 26 16:49:05 2010
@@ -24,7 +24,8 @@ import org.apache.myfaces.extensions.val
import java.util.Locale;
/**
- * Interface for MessageResolvers independent of the message source.
+ * A {@link MessageResolver} is responsible for loading the message for a given key and locale.
+ * The message-source and format depends on the implementation of the resolver.
*
* @author Gerhard Petracek
* @since 1.x.1
@@ -33,12 +34,11 @@ import java.util.Locale;
public interface MessageResolver
{
/**
- * Retrieve the message with a certain key for a certain Locale. When key is null, the return value of the method is
- * also null.
+ * Loads a message-text for the given message-key and locale.
*
- * @param key Message key, can be null or empty
- * @param locale locale for the message
- * @return message corresponding to the key.
+ * @param key key which identifies a message-text
+ * @param locale the target locale of the message
+ * @return message-text
*/
String getMessage(String key, Locale locale);
}
\ No newline at end of file
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterKey.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterKey.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterKey.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterKey.java Tue Oct 26 16:49:05 2010
@@ -28,7 +28,9 @@ import static java.lang.annotation.Eleme
import static java.lang.annotation.ElementType.METHOD;
/**
- * Key part of the ValidationParameter. There can be only one key defined for each different parameter.
+ * Optional key to identify a
+ * {@link org.apache.myfaces.extensions.validator.core.validation.parameter.ValidationParameter}
+ * if there are multiple parameters of the same type.
*
* @author Gerhard Petracek
* @since x.x.3
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterValue.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterValue.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterValue.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ParameterValue.java Tue Oct 26 16:49:05 2010
@@ -28,8 +28,8 @@ import static java.lang.annotation.Eleme
import static java.lang.annotation.ElementType.METHOD;
/**
- * Value part of the ValidationParameter. Multiple values can be defined for one {@link ParameterKey} and they can be
- * distinguished by the id member.
+ * Marker for values within a
+ * {@link org.apache.myfaces.extensions.validator.core.validation.parameter.ValidationParameter} implementation.
*
* @author Gerhard Petracek
* @since x.x.3
@@ -40,9 +40,11 @@ import static java.lang.annotation.Eleme
public @interface ParameterValue
{
/**
- * Identification when multiple values are defined for one key.
+ * It's possible to define multiple values within the
+ * {@link org.apache.myfaces.extensions.validator.core.validation.parameter.ValidationParameter} implementation with
+ * the same type. The optional id allows to identify the value of interest.
*
- * @return By default, the ParameterValue.class value.
+ * @return the type-safe id
*/
Class id() default ParameterValue.class;
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameter.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameter.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameter.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameter.java Tue Oct 26 16:49:05 2010
@@ -22,8 +22,9 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.UsageCategory;
/**
- * Marker interface for the validation parameters. Normally, each parameter has a {@link ParameterKey} and has one or
- * more {@link ParameterValue}. It is also possible to create a validation parameter by just extending this interface.
+ * Marker interface for validation parameters.
+ *
+ * Optionally, a parameter has a {@link ParameterKey} and one or more {@link ParameterValue} annotation/s.
*
* @author Gerhard Petracek
* @since x.x.3
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractor.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractor.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractor.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractor.java Tue Oct 26 16:49:05 2010
@@ -26,7 +26,7 @@ import java.util.List;
import java.lang.annotation.Annotation;
/**
- * Allows the extraction of ValidationParameters.
+ * Allows the extraction of {@link ValidationParameter}s.
*
* @author Gerhard Petracek
* @since x.x.3
@@ -35,51 +35,48 @@ import java.lang.annotation.Annotation;
public interface ValidationParameterExtractor
{
/**
- * Extract all the {@link ValidationParameter}s defined on the annotation. The resulting Map contains as key all
- * the {@link ParameterKey}s found. The value for each key, is the value defined as the {@link ParameterValue}
- * (or the list of) of the ParameterValue part.<br/>
- * When no ValidationParameters found, the method need to return an empty Map.
+ * Extracts all {@link ValidationParameter}s hosted by the given annotation.
+ * The wiki shows all supported styles.
*
- * @param annotation The annotation for which we want to extract the information.
- * @return Map with all ParameterKeys and ParameterValues found.
+ * @param annotation The annotation which might contain validation-parameters
+ * @return key/value map of the found parameters
*/
Map<Object, List<Object>> extract(Annotation annotation);
/**
- * Extract all the values defined as the {@link ParameterValue} found in the annotation for the key which is a
- * {@link ParameterKey}. When no values found, the method returns an empty list.
+ * Extracts all {@link ValidationParameter}s for the given key which are hosted by the given annotation.
+ * The wiki shows all supported styles.
*
* @param annotation The annotation for which we want to extract the information.
- * @param key Value for the ParameterKey that is used for filtering the ValidationParameters found.
- * @return List with all the ParameterValues found.
+ * @param key Value for the ParameterKey that is used for filtering the ValidationParameters.
+ * @return list of the found parameters
*/
List<Object> extract(Annotation annotation, Object key);
/**
- * Extract all the values defined as the {@link ParameterValue} found in the annotation for the key which is a
- * {@link ParameterKey} where only those results are included which are assignable to the type specified in the
- * parameter valueType. When no values found, the method returns an empty list.
+ * Extracts all {@link ValidationParameter}s for the given key which are hosted by the given annotation.
+ * The result is filtered by the given type for the value.
+ * The wiki shows all supported styles.
*
- * @param annotation The annotation for which we want to extract the information.
- * @param key Value for the ParameterKey that is used for filtering the ValidationParameters found.
+ * @param annotation The annotation which might contain validation-parameters
+ * @param key Value for the ParameterKey that is used for filtering the ValidationParameters.
* @param valueType ParameterValue must be assignable to this type to be added to the result.
* @param <T> Class type of the result which is the same as the class type of the parameter valueType.
- * @return List with all the ParameterValues found.
+ * @return list of the found parameters
*/
<T> List<T> extract(Annotation annotation, Object key, Class<T> valueType);
/**
- * Extract the value defined as the {@link ParameterValue} found in the annotation for the key which is a
- * {@link ParameterKey} where only those results are included which are assignable to the type specified in the
- * parameter valueType and the ParameterValue id defined is the same as the parameter valueId. <br/>
- * Multiple ParameterValues can be defined and each of them could be assigned an id to distinguish the different
- * values. <br/>
- * When no value matches the parameters of the method, the result of the method invocation is null.
+ * Extracts all {@link ValidationParameter}s for the given key which are hosted by the given annotation.
+ * The result is filtered by the given type for the value and
+ * the given id to receive a specific value if there are multiple parameters of the same type.
+ * The wiki shows all supported styles.
*
- * @param annotation The annotation for which we want to extract the information.
- * @param key Value for the ParameterKey that is used for filtering the ValidationParameters found.
+ * @param annotation The annotation which might contain validation-parameters
+ * @param key Value for the ParameterKey that is used for filtering the ValidationParameters.
* @param valueType ParameterValue must be assignable to this type to be added to the result.
- * @param valueId value of the id member of the ParameterValue we are looking for.
+ * @param valueId marker which identifies a specific value
+ * (needed if there are multiple parameters of the same type)
* @param <T> Class type of the result which is the same as the class type of the parameter valueType.
* @return Value of the found ParameterValue.
*/
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractorFactory.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractorFactory.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractorFactory.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/parameter/ValidationParameterExtractorFactory.java Tue Oct 26 16:49:05 2010
@@ -22,8 +22,7 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.UsageCategory;
/**
- * Definition of the factory class which is capable of creating classes that can extract ValidationParameter's from
- * the annotations.
+ * Interface for a factory which is responsible for creating a {@link ValidationParameterExtractor}
*
* @author Gerhard Petracek
* @since x.x.3
@@ -33,7 +32,7 @@ public interface ValidationParameterExtr
{
/**
* Creates an instance of a class capable of extracting ValidationParameter's from annotations.
- * @return Extractor for ValidationParameter's from annotations.
+ * @return an instance of type {@link ValidationParameterExtractor}s for extracting generic params from annotations.
*/
ValidationParameterExtractor create();
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/AbstractValidationStrategy.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/AbstractValidationStrategy.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/AbstractValidationStrategy.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/AbstractValidationStrategy.java Tue Oct 26 16:49:05 2010
@@ -30,10 +30,9 @@ import javax.faces.validator.ValidatorEx
import java.util.logging.Logger;
/**
- * Provides the ability to use ValidatorException (as expected by the user) instead of ConverterException.
- * Furthermore it provides:<br/>
- * initValidation<br/>
- * processAfterValidatorException
+ * Provides the ability to use {@link ValidatorException} (as expected by the user) instead of the internally needed
+ * {@link javax.faces.convert.ConverterException}. Furthermore, this base implementation introduces a hook for the
+ * initialization of validators and the interception of {@link ValidatorException}s.
*
* @author Gerhard Petracek
* @since 1.x.1
@@ -50,11 +49,11 @@ public abstract class AbstractValidation
/**
* {@inheritDoc}
- * Before actually executing the validation (done by the method processValidation) any initialization can be
- * performed by the overriding the initValidation method. When a Validation exception occurs, the method
- * processAfterValidatorException executes the registered
- * {@link org.apache.myfaces.extensions.validator.core.interceptor.ValidationExceptionInterceptor}'s.
*
+ * Before actually executing the validation ({@link #processValidation}) any initialization can be
+ * performed by overriding {@link #initValidation}. If a Validation exception occurs, the method
+ * {@link #processAfterValidatorException} executes the registered
+ * {@link org.apache.myfaces.extensions.validator.core.interceptor.ValidationExceptionInterceptor}'s.
*/
public void validate(FacesContext facesContext, UIComponent uiComponent,
MetaDataEntry metaDataEntry, Object convertedObject)
@@ -123,9 +122,10 @@ public abstract class AbstractValidation
//override if needed
}
- //override if needed
/**
- * Executes the registered ValidationExceptionInterceptor to process the validation exception.
+ * Executes the registered
+ * {@link org.apache.myfaces.extensions.validator.core.interceptor.ValidationExceptionInterceptor}
+ * to process the validation exception.
*
* @param facesContext The JSF Context
* @param uiComponent The JSF component that contained the value entered by the user.
@@ -148,10 +148,8 @@ public abstract class AbstractValidation
}
/**
- /**
- * Validates the value in the convertedObject parameter which the user entered as value of the uiComponent.
- * Additional validation information can be found in the metaDataEntry parameter. The method throws a
- * ValidatorException when violation of the validation rules occurs.
+ * Validates the given value based on the given meta-data entry.
+ * The method throws a {@link ValidatorException} if a violation is detected
*
* @param facesContext The JSF Context
* @param uiComponent The JSF component that contained the value entered by the user.
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/ValidationStrategy.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/ValidationStrategy.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/ValidationStrategy.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/core/validation/strategy/ValidationStrategy.java Tue Oct 26 16:49:05 2010
@@ -26,20 +26,21 @@ import javax.faces.component.UIComponent
import javax.faces.context.FacesContext;
/**
- * Base interface for ValidationStrategies. A validation strategy is responsible for validating a certain rule, like
- * required or a custom validation rule. A convenient abstract base class is AbstractValidationStrategy.
+ * Base interface for ValidationStrategies. A validation strategy is responsible for validating a certain constraint.
+ * Furthermore, it can be an adapter for other validation frameworks like bean-validation and it's used to link e.g.
+ * a constraint with a message resolver.
+ *
+ * @see org.apache.myfaces.extensions.validator.core.validation.strategy.AbstractValidationStrategy
*
* @author Gerhard Petracek
* @since 1.x.1
- * @see org.apache.myfaces.extensions.validator.core.validation.strategy.AbstractValidationStrategy
*/
@UsageInformation(UsageCategory.API)
//*ValidationStrategy instead of *Validator to avoid naming confusion
public interface ValidationStrategy
{
/**
- * Validates the value in the convertedObject parameter which the user entered as value of the uiComponent.
- * Additional validation information can be found in the metaDataEntry parameter.
+ * Validates the convertedObject against the given {@link MetaDataEntry}.
*
* @param facesContext The JSF Context
* @param uiComponent The JSF component that contained the value entered by the user.
@@ -47,6 +48,8 @@ public interface ValidationStrategy
* around.
* @param convertedObject Converted object of the user entered value.
*/
- void validate(FacesContext facesContext, UIComponent uiComponent,
- MetaDataEntry metaDataEntry, Object convertedObject);
+ void validate(FacesContext facesContext,
+ UIComponent uiComponent,
+ MetaDataEntry metaDataEntry,
+ Object convertedObject);
}
Modified: myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/util/ExtValAnnotationUtils.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/util/ExtValAnnotationUtils.java?rev=1027642&r1=1027641&r2=1027642&view=diff
==============================================================================
--- myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/util/ExtValAnnotationUtils.java (original)
+++ myfaces/extensions/validator/trunk/core/src/main/java/org/apache/myfaces/extensions/validator/util/ExtValAnnotationUtils.java Tue Oct 26 16:49:05 2010
@@ -37,7 +37,7 @@ import org.apache.myfaces.extensions.val
import org.apache.myfaces.extensions.validator.internal.Priority;
/**
- * Contains helper methods that are dealing with annotation usage in the context of ExtVal.
+ * Contains helper methods which are dealing with general tasks liked to annotation
*
* @author Gerhard Petracek
* @since r4
@@ -48,16 +48,15 @@ public class ExtValAnnotationUtils
{
private static final Logger LOGGER = Logger.getLogger(ExtValAnnotationUtils.class.getName());
- @ToDo(value = Priority.HIGH, description = "add cache")
/**
- * Extract all annotations found on a property. It looks for them on getter method, the field and all getters
- * that are defined in interfaces. The name of the property for which the annotations are searched, is passed
- * as value of the field property of the parameter propertyDetails.
+ * Extracts all annotations found on a property. It looks for them on getter method, the field and all getters
+ * that are defined in interfaces. The name of the target property is provided by the propertyDetails parameter.
*
- * @param entityClass Class object where the annotations are searched.
- * @param propertyDetails Information on the property where are interested in.
- * @return Object with information and metaDataEntries for the annotations.
+ * @param entityClass target class which has to be scanned
+ * @param propertyDetails information about the property
+ * @return a datastructure which contains all information about the target-property
*/
+ @ToDo(value = Priority.HIGH, description = "add cache")
public static PropertyInformation extractAnnotations(Class entityClass, PropertyDetails propertyDetails)
{
PropertyInformation propertyInformation = new DefaultPropertyInformation();
@@ -78,17 +77,18 @@ public class ExtValAnnotationUtils
return propertyInformation;
}
- @ToDo(value = Priority.HIGH, description = "add cache")
/**
- * Extract all annotations found on the getter method of a property. The annotations are added to the
- * propertyInformation MetaDataEntries.
+ * Extracts all annotations found at the getter method of a property.
+ * The annotations are added to the given propertyInformation parameter.
*
- * @param storage PropertyStorage where the getter method could be cached.
- * @param entity Class object where the annotations are searched.
- * @param property Name of the property we are interested.
+ * @param storage {@link PropertyStorage} which is able to cache information of a property
+ * @param entity target class which has to be scanned
+ * @param property Name of the property we are interested in.
* @param propertyInformation Where the MetaDataEntries for the annotations are added.
*/
- public static void addPropertyAccessAnnotations(PropertyStorage storage, Class entity,
+ @ToDo(value = Priority.HIGH, description = "add cache")
+ public static void addPropertyAccessAnnotations(PropertyStorage storage,
+ Class entity,
String property,
PropertyInformation propertyInformation)
{
@@ -100,16 +100,19 @@ public class ExtValAnnotationUtils
}
}
- @ToDo(value = Priority.HIGH, description = "add cache")
/**
- * Extract all annotations found the field of the property. A field name with an additional _ (underscore) is also
- * searched. The annotations are added to the propertyInformation MetaDataEntries.
- * @param storage PropertyStorage where the field could be cached.
- * @param entity Class object where the annotations are searched.
- * @param property Name of the property we are interested.
+ * Extracts all annotations found at the field of the property.
+ * A field name with a _ (underscore) as prefix is also supported.
+ * The annotations are added to the given propertyInformation parameter.
+ *
+ * @param storage {@link PropertyStorage} which is able to cache information of a property
+ * @param entity target class which has to be scanned
+ * @param property Name of the property we are interested in.
* @param propertyInformation Where the MetaDataEntries for the annotations are added.
*/
- public static void addFieldAccessAnnotations(PropertyStorage storage, Class entity,
+ @ToDo(value = Priority.HIGH, description = "add cache")
+ public static void addFieldAccessAnnotations(PropertyStorage storage,
+ Class entity,
String property,
PropertyInformation propertyInformation)
{
@@ -155,13 +158,12 @@ public class ExtValAnnotationUtils
}
/**
- * Extract the value of the annotation property named value. The value is cast as a value of the parameter
- * targetClass.
+ * Extracts the value of the given annotation.
*
- * @param annotation The annotations that is used to extract the property value from.
- * @param targetClass Type of the property named value.
+ * @param annotation The target annotation
+ * @param targetClass Type of the value-property
* @param <T> Result class
- * @return value of the annotation property named value
+ * @return value of the value-property
*/
public static <T> T extractValueOf(Annotation annotation, Class<T> targetClass)
{