org.everit.json.schema.internal

Class EmailFormatValidator

java.lang.Object

org.everit.json.schema.internal.AFormatValidator

org.everit.json.schema.internal.EmailFormatValidator

All Implemented Interfaces:

FormatValidator

public class EmailFormatValidator
extends AFormatValidator

Implementation of the "email" format value.

Field Summary

Fields inherited from interface org.everit.json.schema.FormatValidator

NONE

Constructor Summary

Constructors

Constructor and Description
EmailFormatValidator()

Method Summary

Modifier and Type	Method and Description
String	formatName() Provides the name of this format.
java8.util.Optional<String>	validate(String subject) Implementation-specific validation of subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailFormatValidator

public EmailFormatValidator()

Method Detail

validate

public java8.util.Optional<String> validate(String subject)

Description copied from interface: FormatValidator

Implementation-specific validation of subject. If a validation error occurs then implementations should return a programmer-friendly error message as a String wrapped in an Optional. If the validation succeeded then an empty optional should be returned.

Parameters:

subject - the string to be validated

Returns:

an Optional wrapping the error message if a validation error occured, otherwise an empty optional.

formatName

public String formatName()

Description copied from class: AFormatValidator

Provides the name of this format.

Unless specified otherwise the SchemaLoader will use this name to recognize string schemas using this format.

The default implementation of this method returns "unnamed-format". It is strongly recommended for implementations to give a more meaningful name by overriding this method.

Overrides:

formatName in class AFormatValidator

Returns:

the format name.