org.granite.validation.constraints.Pattern

Package	org.granite.validation.constraints
Class	public class Pattern
Inheritance	Pattern BaseConstraint

The ActionsScript3 implementation of the javax.validation.constraints.Pattern annotation validator.

The annotated String must match the supplied regular expression.

Accepted arguments are:

message (optional): used to create the error message (override the default message).
groups (optional): a comma separated list of fully qualified interface names that specifies the processing groups with which the constraint declaration is associated.
payload (optional): a comma separated list of String that specifies the payloads with which the constraint declaration is associated (unlike the Java implementation, payloads are arbitrary Strings and does not represent necessarily existing class names).
regexp (required): the regular expression to match.
flags (optional): a comma separated flag list considered when resolving the regular expression.

Supported types are:

String

null elements are considered valid.

Example:

  [Pattern(message="{my.custom.message}", groups="path.to.MyGroup1, path.to.MyGroup2", regexp="[a-z]+", flags="CASE_INSENSITIVE, DOTALL")]
  public function get property():String {
      ...
  }

General notes on escaping:

Double quotes: all double quotes (") in argument values must be escaped by using the XML entity (").
Ampersand: all ampersands (&) in argument values should be escaped by using the XML entity (&).
Less and greater than: all "less than" (<) characters in argument values must be escaped by using the XML entity (<). All "greater than" (>) characters in argument values should be escaped by using the XML entity (>)
White spaces: since all argument values are trimed, you may use the pseudo XML entity (&space;) in order to keep leading or trailing white spaces in literals.
Comma: arguments specified as comma separated String lists (such as groups) may use the pseudo XML entity (,) in order to keep comma characters in literals.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		factory : ValidatorFactory The `ValidatorFactory` passed to the `initialized` function.	BaseConstraint
		flags : Array [read-only] The array of flags considered when resolving the regular expression.	Pattern
		groups : Array The processing groups with which this constraint is associated as an array of `Class`.	BaseConstraint
		message : String The error message associated with this constraint.	BaseConstraint
		payload : Array The payload with which this constraint is associated as an array of `String`.	BaseConstraint
		properties : Array The properties with which this constraint is associated as an array of `String` (only for class-level constraints that deal with one or more properties, in order to figure out where error messages should be displayed when this constraint fails).	BaseConstraint
		regexp : String [read-only] The regular expression to match.	Pattern

	Property	Defined by
		_factory : ValidatorFactory Direct access (protected) to the `ValidatorFactory` instance passed to the initialized function.	BaseConstraint
		_groups : Array Direct access (protected) to the groups defined for this constraint.	BaseConstraint
		_message : String Direct access (protected) to the message key defined for this constraint.	BaseConstraint
		_payload : Array Direct access (protected) to the payload defined for this constraint.	BaseConstraint
		_properties : Array Direct access (protected) to the properties defined for this constraint.	BaseConstraint

	Method	Defined by
		initialize(annotation:Annotation, factory:ValidatorFactory):void Initialize this constraint, according to the supplied annotation parameters.	Pattern
		validate(value:*):String Validate the `value` parameter, according to this constraint specification.	Pattern

	Method	Defined by
		createMessageParameter(message:String):ParameterDefinition [static] Creates a definition of the standard `message` annotation argument with the supplied string.	BaseConstraint
		internalInitialize(factory:ValidatorFactory, annotation:Annotation, defaultMessage:String, parameterDefinitions:Array = null):Dictionary Parse constraint parameters according to the annotation arguments, initialize the message, groups and payload properties and return a `Dictionary` that contains all parsed values.	BaseConstraint

	Constant	Defined by
		CASE_INSENSITIVE : String = "CASE_INSENSITIVE" [static] Enables case-insensitive matching (see `java.util.regex.Pattern#CASE_INSENSITIVE`).	Pattern
		DEFAULT_MESSAGE : String = "{javax.validation.constraints.Pattern.message}" [static] The default message key of this constraint.	Pattern
		DOTALL : String = "DOTALL" [static] Enables dotall mode (see `java.util.regex.Pattern#DOTALL`).	Pattern
		MULTILINE : String = "MULTILINE" [static] Enables multiline mode (see `java.util.regex.Pattern#MULTILINE`).	Pattern

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined by
		BOOLEAN_TYPES : Array [static] An array of boolean types: `[Boolean]` (used when checking the value type of a constraint annotation argument).	BaseConstraint
		DATE_TYPES : Array [static] An array of date types: `[Date]` (used when checking the value type of a constraint annotation argument).	BaseConstraint
		GROUPS_PARAMETER : ParameterDefinition [static] The definition of the standard `groups` constraint annotation argument, as an optional array of `Class` names.	BaseConstraint
		NUMBER_STRING_TYPES : Array [static] An array of numeric or string types: `[BigDecimal, BigInteger, Long, Number, int, uint String]` (used when checking the value type of a constraint annotation argument).	BaseConstraint
		PAYLOAD_PARAMETER : ParameterDefinition [static] The definition of the standard `payload` constraint annotation argument, as an optional array of `String`s.	BaseConstraint
		PROPERTIES_PARAMETER : ParameterDefinition [static] The definition of the standard `properties` constraint annotation argument, as an optional array of `String`s.	BaseConstraint
		STRING_TYPES : Array [static] An array of string types: `[String]` (used when checking the value type of a constraint annotation argument).	BaseConstraint

Property detail

flags

property

flags:Array [read-only]

The array of flags considered when resolving the regular expression.

Implementation
public function get flags():Array

See also

CASE_INSENSITIVE
DOTALL
MULTILINE

regexp

property

regexp:String [read-only]

The regular expression to match.

Implementation
public function get regexp():String

Method detail

initialize

()

method

public override function initialize(annotation:Annotation, factory:ValidatorFactory):void

Initialize this constraint, according to the supplied annotation parameters.

The org.granite.validation.BaseConstraint implementation of this method throws an Error and must be overridden in inherited classes.

Parameters

	`annotation:Annotation` — the anntotation defining this constraint.

	`factory:ValidatorFactory`

validate

()

method

public override function validate(value:*):String

Validate the value parameter, according to this constraint specification.

The org.granite.validation.BaseConstraint implementation of this method throws an Error and must be overridden in inherited classes.

Parameters

value:* — the value to be validated.

Returns

String — null if the supplied value is valid, an error message key otherwise.

Constant detail

CASE_INSENSITIVE

constant

public static const CASE_INSENSITIVE:String = "CASE_INSENSITIVE"

Enables case-insensitive matching (see java.util.regex.Pattern#CASE_INSENSITIVE).

DEFAULT_MESSAGE

constant

public static const DEFAULT_MESSAGE:String = "{javax.validation.constraints.Pattern.message}"

The default message key of this constraint.

DOTALL

constant

public static const DOTALL:String = "DOTALL"

Enables dotall mode (see java.util.regex.Pattern#DOTALL).

MULTILINE

constant

public static const MULTILINE:String = "MULTILINE"

Enables multiline mode (see java.util.regex.Pattern#MULTILINE).

Granite Data Services API Documentation (3.0.0.M2)	All Packages \| All Classes \| Index \| Frames No Frames
Class Pattern	Properties \| Methods \| Constants