Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.opensymphony.xwork2.validator.validators
Class ValidatorSupport

    java.lang.Object
      com.opensymphony.xwork2.validator.validators.ValidatorSupport

All Implemented Interfaces:
  ShortCircuitableValidator, Validator

Direct Known Subclasses:
  ExpressionValidator, FieldValidatorSupport

    public abstract class ValidatorSupport

extends Object
implements Validator, ShortCircuitableValidator

Abstract implementation of the Validator interface suitable for subclassing.

Author:
  Jason Carreira

Field Summary
`protected String` | `defaultMessage`
`protected Log` | `log`
`protected String` | `messageKey`
`private boolean` | `parse`
`private boolean` | `shortCircuit`
`private String` | `type`
`private ValidatorContext` | `validatorContext`

Constructor Summary
`ValidatorSupport()`

Method Summary
`protected void` | `addActionError(Object object)`
`protected void` | `addFieldError(String propertyName, Object object)`
`protected Object` | `conditionalParse(String expression)` Parse `expression` passed in against value stack.
`String` | `getDefaultMessage()`
`protected Object` | `getFieldValue(String name, Object object)` Return the field value named `name` from `object`, `object` should have the appropriate getter/setter.
`String` | `getMessage(Object object)`
`String` | `getMessageKey()`
`boolean` | `getParse()`
`ValidatorContext` | `getValidatorContext()`
`String` | `getValidatorType()`
`boolean` | `isShortCircuit()` Gets whether this field validator should short circuit the validator queue it's in if validation fails.
`void` | `setDefaultMessage(String message)`
`void` | `setMessageKey(String key)`
`void` | `setParse(boolean parse)`
`void` | `setShortCircuit(boolean shortcircuit)` Sets whether this field validator should short circuit the validator queue it's in if validation fails.
`void` | `setValidatorContext(ValidatorContext validatorContext)` This method will be called before validate with a non-null ValidatorContext.
`void` | `setValidatorType(String type)`

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

Methods inherited from interface com.opensymphony.xwork2.validator.Validator
`validate`

Field Detail

### log

    protected final Log log

### defaultMessage

    protected String defaultMessage

### messageKey

    protected String messageKey

### validatorContext

    private ValidatorContext validatorContext

### shortCircuit

    private boolean shortCircuit

### parse

    private boolean parse

### type

    private String type

Constructor Detail

### ValidatorSupport

    public ValidatorSupport()

Method Detail

### setDefaultMessage

    public void setDefaultMessage(String message)

  Specified by:
    `setDefaultMessage` in interface `Validator`

### getDefaultMessage

    public String getDefaultMessage()

  Specified by:
    `getDefaultMessage` in interface `Validator`

### setParse

    public void setParse(boolean parse)

### getParse

    public boolean getParse()

### getMessage

    public String getMessage(Object object)

  Specified by:
    `getMessage` in interface `Validator`

### setMessageKey

    public void setMessageKey(String key)

  Specified by:
    `setMessageKey` in interface `Validator`

### getMessageKey

    public String getMessageKey()

  Specified by:
    `getMessageKey` in interface `Validator`

### setShortCircuit

    public void setShortCircuit(boolean shortcircuit)

  Description copied from interface: `ShortCircuitableValidator`
  Sets whether this field validator should short circuit the validator queue it's in if validation fails.

  Specified by:
    `setShortCircuit` in interface `ShortCircuitableValidator`
  Parameters:
    `shortcircuit` - true if this field validator should short circuit on failure, false otherwise

### isShortCircuit

    public boolean isShortCircuit()

  Description copied from interface: `ShortCircuitableValidator`
  Gets whether this field validator should short circuit the validator queue it's in if validation fails.

  Specified by:
    `isShortCircuit` in interface `ShortCircuitableValidator`
  Returns:
    true if this field validator should short circuit on failure, false otherwise

### setValidatorContext

    public void setValidatorContext(ValidatorContext validatorContext)

  Description copied from interface: `Validator`
  This method will be called before validate with a non-null ValidatorContext.

  Specified by:
    `setValidatorContext` in interface `Validator`

### getValidatorContext

    public ValidatorContext getValidatorContext()

  Specified by:
    `getValidatorContext` in interface `Validator`

### setValidatorType

    public void setValidatorType(String type)

  Specified by:
    `setValidatorType` in interface `Validator`

### getValidatorType

    public String getValidatorType()

  Specified by:
    `getValidatorType` in interface `Validator`

### conditionalParse

    protected Object conditionalParse(String expression)

  Parse `expression` passed in against value stack. Only parse when 'parse' param is set to true, else just returns the expression unparsed.

  Parameters:
    `expression` -
  Returns:
    Object

### getFieldValue

    protected Object getFieldValue(String name,
                                   Object object)
                            throws ValidationException

  Return the field value named `name` from `object`, `object` should have the appropriate getter/setter.

  Parameters:
    `name` -
    `object` -
  Returns:
    Object as field value
  Throws:
    `ValidationException`

### addActionError

    protected void addActionError(Object object)

### addFieldError

    protected void addFieldError(String propertyName,
                                 Object object)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.