Package name.matthewgreet.strutscommons.util

Class InterceptorCommonLibrary

java.lang.Object
name.matthewgreet.strutscommons.util.InterceptorCommonLibrary
public class InterceptorCommonLibrary extends Object
Static functions used by validation Interceptors, form formating Interceptors and validators.

  • Field Details

  • Constructor Details

    • InterceptorCommonLibrary

      public InterceptorCommonLibrary()

  • Method Details

    • categoriseFormFields

      public static <T> InterceptorCommonLibrary.CategoriseFieldResult categoriseFormFields(Collection<Field> formFields, PolicyLookup policyLookup, boolean ignoreNonAnnotatedField)
      Sets how each form field should be converted.

    • checkCollectionRecipientDataType

      public static <T> boolean checkCollectionRecipientDataType(Field recipientField, Class<T> recipientClass)
      Returns whether converting validator can convert form field value to the recipient field's type.

    • checkFieldClass

      public static boolean checkFieldClass(Class<?> conversionClass, Class<?> fieldClass)
      Returns whether a converter's target data type can convert to the form field's data type.

    • checkRecipientDataType

      public static boolean checkRecipientDataType(Field recipientField, Class<?> recipientClass)
      Returns whether converting validator can convert form field value to the recipient field's type.

    • fieldIsNotForm

      public static boolean fieldIsNotForm(Field actionField)
      Returns whether a viewer Action's member field is definitely not a form.

    • fieldReceivedStoredForm

      public static boolean fieldReceivedStoredForm(Field actionField)
      Returns whether field of an Action received a stored form.

    • filterNonConversionErrorFormFields

      public static Collection<Field> filterNonConversionErrorFormFields(Collection<Field> formFields, Map<String,ConversionData> conversionErrors)
      Returns form member fields that didn't have a conversion error.

    • filterPlausibleFormFields

      public static Collection<Field> filterPlausibleFormFields(Collection<Field> formFields)
      Returns form member fields that can plausibly receive form data. This excludes static and final fields.

    • formatCollectionFormField

      public static <T> void formatCollectionFormField(Object form, Collection<Field> allFormFields, Field formField, InterceptorCommonLibrary.ConfiguredPolicy<T> configuredPolicy)
      Sets text for not yet set form field.

    • formatFormField

      public static <T> void formatFormField(Object form, Collection<Field> allFormFields, Field formField, InterceptorCommonLibrary.ConfiguredPolicy<T> configuredPolicy)
      Sets text for not yet set form field.

    • getActionContextFormattedForms

      public static Map<String,Map<String,Object>> getActionContextFormattedForms()
      Returns the formatted forms created by FormFormatterInterceptor. As these are only created by a Struts 2 pre-result listener set by the Interceptor, no result is available till then. This is meant for the Interceptor and Actions should use StrutsMiscellaneousLibrary.getFormattedForms() as it's easier to use.

    • getAnnotationEntries

      public static <T> InterceptorCommonLibrary.AnnotationEntries<T> getAnnotationEntries(Field formField, PolicyLookup policyLookup)
      Returns all recognised annotations and their linked policies.

    • getAnnotationUsageFromPolicyClass

      public static InterceptorCommonLibrary.AnnotationUsage getAnnotationUsageFromPolicyClass(Class<?> policyClass)
      Returns category of form field policy implementation class or NA if not applicable.

    • getBuiltInDefaultCollectionConverters

      public static List<InterceptorCommonLibrary.DefaultCollectionConverterEntry<?,?>> getBuiltInDefaultCollectionConverters()
      Returns built-in single value converters.

    • getBuiltInDefaultConverters

      public static List<InterceptorCommonLibrary.DefaultConverterEntry<?,?>> getBuiltInDefaultConverters()
      Returns built-in single value converters.

    • getBuiltInPolicies

      public static List<InterceptorCommonLibrary.PolicyEntry<?,?,?>> getBuiltInPolicies()
      Returns built-in adjusters, converters, and validators.

    • getConfiguredPolicy

      public static <T> InterceptorCommonLibrary.ConfiguredPolicy<T> getConfiguredPolicy(Annotation annotation, PolicyLookup policyLookup) throws Exception
      Returns configured policy instance that processes an annotated form field, or result of NA type if not recognised.
      Throws:
      Exception

    • getConverterClassLookupFromFormFieldClass

      public static Class<?> getConverterClassLookupFromFormFieldClass(Class<?> fieldClass)
      Returns class used in default converter and default collection converter lookup from a form field's type or item class for collection types.

    • getDefaultCollectionConverter

      public static CollectionConverter<?,?> getDefaultCollectionConverter(Field field, PolicyLookup policyLookup)
      Returns default collection converter for a collection form field or display field, or null if none available.

    • getDefaultConverter

      public static Converter<?,?> getDefaultConverter(Field field, PolicyLookup policyLookup)
      Returns default converter for a single value form field or display field, or null if none available.

    • getDefaultConverterFromArray

      public static Converter<?,?> getDefaultConverterFromArray(Field field, PolicyLookup policyLookup)
      Returns default converter for each item of an array display field, or null if none available. Not used for form fields.

    • getDefaultConverterFromCollection

      public static Converter<?,?> getDefaultConverterFromCollection(Field field, PolicyLookup policyLookup)
      Returns default converter for each item of a collection display field, or null if none available. Not used for form fields.

    • getDefaultRecipientName

      public static String getDefaultRecipientName(String fieldName)
      Returns the default field name to receive a converted form field.

    • getForm

      public static Object getForm(Object action)
      Returns the object expected to receive submitted form data on behalf of an Action. This can be the model of a ModelDriven Action, or the Action itself.

    • getFormFieldCategory

      public static InterceptorCommonLibrary.FormFieldCategory getFormFieldCategory(InterceptorCommonLibrary.FieldUsage<?> fieldUsage)

    • getFormFieldUsage

      public static <T> InterceptorCommonLibrary.FieldUsage<T> getFormFieldUsage(Field formField, PolicyLookup policyLookup) throws FormFieldAnnotationTypeMismatchException
      Returns what policies should apply to a form field, such as conversion and validation, or throws FormFieldAnnotationTypeMismatchException if any annotation does not match the field's type.
      Throws:
      FormFieldAnnotationTypeMismatchException

    • getProperties

      public static Collection<Field> getProperties(Class<?> type)
      Returns all properties of a class, even private ones, whether directly declared or inherited.

    • getProperty

      public static Field getProperty(Class<?> type, String name)
      Returns property of a class, even if private or inherited, or null if not found.

    • getStoredForm

      public static FormStoreInterceptor.StoredForm getStoredForm()
      Returns a processed form stored in session.

    • getTypeFromArrayField

      public static <T> Class<T> getTypeFromArrayField(Field recipientField)
      Returns element type of a collection-based form field.

    • getTypeFromCollectionField

      public static <T> Class<T> getTypeFromCollectionField(Field recipientField)
      Returns element type of a collection-based form field.

    • isCustomAnnotationClass

      public static <A extends Annotation> boolean isCustomAnnotationClass(Class<A> annotationClass)
      Returns whether an annotation class is for custom policies.

    • makeCollectionForRecipient

      public static <T> Collection<T> makeCollectionForRecipient(Class<?> recipientClass)
      Returns an empty, modifiable collection from a collection type.