= @Email
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Meta-annotation for an optional _String_ property or parameter representing an email address.

== API

[source,java]
.Email.java
----
@interface Email {
  int MAX_LENGTH;     // <.>
  String REGEX_PATTERN;     // <.>
  String REGEX_PATTERN_REPLACEMENT;
  @AliasFor(annotation = Property.class, attribute = "maxLength")
int propertyMaxLength() default MAX_LENGTH;
  @AliasFor(annotation = Parameter.class, attribute = "maxLength")
int parameterMaxLength() default MAX_LENGTH;
  @AliasFor(annotation = Property.class, attribute = "optionality")
Optionality propertyOptionality() default Optionality.OPTIONAL;
  @AliasFor(annotation = Parameter.class, attribute = "optionality")
Optionality parameterOptionality() default Optionality.OPTIONAL;
  @AliasFor(annotation = Property.class, attribute = "regexPattern")
String propertyRegexPattern() default REGEX_PATTERN;
  @AliasFor(annotation = Parameter.class, attribute = "regexPattern")
String parameterRegexPattern() default REGEX_PATTERN;
  @AliasFor(annotation = Property.class, attribute = "regexPatternReplacement")
String propertyRegexPatternReplacement() default REGEX_PATTERN_REPLACEMENT;
  @AliasFor(annotation = Parameter.class, attribute = "regexPatternReplacement")
String parameterRegexPatternReplacement() default REGEX_PATTERN_REPLACEMENT;
  @AliasFor(annotation = javax.jdo.annotations.Column.class, attribute = "allowsNull")
String columnAllowsNull() default "true";
  @AliasFor(annotation = javax.jdo.annotations.Column.class, attribute = "length")
int columnLength() default MAX_LENGTH;
}
----

<.> xref:#MAX_LENGTH[MAX_LENGTH]
+
--
Seemaximum length of an email address.
--
<.> xref:#REGEX_PATTERN[REGEX_PATTERN]
+
--
as per http://emailregex.com/
--

== Members

[#MAX_LENGTH]
=== MAX_LENGTH

Seemaximum length of an email address.

[#REGEX_PATTERN]
=== REGEX_PATTERN

as per http://emailregex.com/
