org.apache.tapestry.form.validator
Class MaxLength

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

All Implemented Interfaces:

FormComponentContributor, Validator

public class MaxLength
extends BaseValidator

Validator that ensures a string value does not exceed a maximum length.

Since:

4.0

Author:

Howard Lewis Ship

Constructor Summary

MaxLength()

MaxLength(String initializer)

Method Summary

protected String	buildMessage(ValidationMessages messages, IFormComponent field)
int	getMaxLength()
void	renderContribution(IMarkupWriter writer, IRequestCycle cycle, FormComponentContributorContext context, IFormComponent field) Does nothing.
void	setMaxLength(int maxLength)
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, getAcceptsNull, getFieldTranslator, getMessage, isRequired, setMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxLength

public MaxLength()

MaxLength

public MaxLength(String initializer)

Method Detail

setMaxLength

public void setMaxLength(int maxLength)

getMaxLength

public int getMaxLength()

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

protected 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