org.apache.tapestry.form.validator
Class Required

java.lang.Object
  org.apache.tapestry.form.validator.BaseValidator
      org.apache.tapestry.form.validator.Required

All Implemented Interfaces:

FormComponentContributor, Validator

public class Required
extends BaseValidator

Validator that ensures a value was supplied.

Since:

4.0

Author:

Howard Lewis Ship

Constructor Summary

Required()

Required(String initializer)

Method Summary

String	buildMessage(ValidationMessages messages, IFormComponent field)
boolean	getAcceptsNull() Returns false.
boolean	isRequired() Returns true, that's what Required means!
void	renderContribution(IMarkupWriter writer, IRequestCycle cycle, FormComponentContributorContext context, IFormComponent field) Does nothing.
void	validate(IFormComponent field, ValidationMessages messages, Object object) Invoked to validate input for the field.

Methods inherited from class org.apache.tapestry.form.validator.BaseValidator

accumulateProfileProperty, accumulateProperty, getFieldTranslator, getMessage, setMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

Required

public Required()

Required

public Required(String initializer)

Method Detail

getAcceptsNull

public boolean getAcceptsNull()

Description copied from class: BaseValidator

Returns false.

Specified by:

getAcceptsNull in interface Validator

Overrides:

getAcceptsNull in class BaseValidator

validate

public void validate(IFormComponent field,
                     ValidationMessages messages,
                     Object object)
              throws ValidatorException

Description copied from interface: Validator

Invoked to validate input for the field. A Translator will have already converted the submitted user input string into an object.

Parameters:

field - the form element component being validated, often used to determine the user presentable name for the field, used in error messages.

messages - access to the pre-defined validation messages, in the appropriate locale

object - the client-side representation of the field's data. May be null if the client did not provide a value for the field (most Validators should check for null and perform no check if null).

Throws:

ValidatorException - if the object violates the constraint represented by this Validator.

buildMessage

public String buildMessage(ValidationMessages messages,
                           IFormComponent field)

renderContribution

public void renderContribution(IMarkupWriter writer,
                               IRequestCycle cycle,
                               FormComponentContributorContext context,
                               IFormComponent field)

Description copied from class: BaseValidator

Does nothing.

Specified by:

renderContribution in interface FormComponentContributor

Overrides:

renderContribution in class BaseValidator

Parameters:

writer - allows contributor to write additional attributes into the component's tag

cycle - for accessing request information

context - utilities for genering messages and client-side validation

field - the field for which contributions are being rendered

isRequired

public boolean isRequired()

Returns true, that's what Required means!

Specified by:

isRequired in interface Validator

Overrides:

isRequired in class BaseValidator