Class StringFormatValidator
- java.lang.Object
-
- org.jboss.logging.processor.validation.StringFormatValidator
-
- All Implemented Interfaces:
FormatValidator
public final class StringFormatValidator extends java.lang.Object
A string format representation. Date: 13.06.2011- Author:
- James R. Perkins
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.regex.Pattern
PATTERN
The Regex pattern.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
argumentCount()
The number of arguments needed for the format.java.lang.String
asFormat()
Recreates the format using the internal formatting descriptors.java.lang.String
detailMessage()
A detail message ifFormatValidator.isValid()
returnsfalse
, otherwise an empty string.java.lang.String
format()
Returns the format string used for validation.boolean
isValid()
Returnstrue
of the format is valid, otherwisefalse
.static StringFormatValidator
of(java.lang.String format)
Creates a string format.static StringFormatValidator
of(java.lang.String format, java.lang.Object... parameters)
Creates a string format.java.lang.String
summaryMessage()
A summary message ifFormatValidator.isValid()
returnsfalse
, otherwise an empty string.java.lang.String
toString()
static StringFormatValidator
withTranslation(java.lang.String format, java.lang.String translationFormat)
Creates a string format.
-
-
-
Method Detail
-
of
public static StringFormatValidator of(java.lang.String format)
Creates a string format.- Parameters:
format
- the format.- Returns:
- the string format.
-
withTranslation
public static StringFormatValidator withTranslation(java.lang.String format, java.lang.String translationFormat)
Creates a string format. Note: The validator returned is the validator for the translation format.- Parameters:
format
- the format.translationFormat
- the format of the translation- Returns:
- the string format.
-
of
public static StringFormatValidator of(java.lang.String format, java.lang.Object... parameters)
Creates a string format.- Parameters:
format
- the format.parameters
- the parameters to validate against.- Returns:
- the string format.
-
argumentCount
public int argumentCount()
Description copied from interface:FormatValidator
The number of arguments needed for the format.- Returns:
- the number of arguments needed.
-
format
public java.lang.String format()
Description copied from interface:FormatValidator
Returns the format string used for validation.- Returns:
- the format string.
-
isValid
public boolean isValid()
Description copied from interface:FormatValidator
Returnstrue
of the format is valid, otherwisefalse
.- Returns:
true
of the format is valid, otherwisefalse
.
-
asFormat
public java.lang.String asFormat()
Recreates the format using the internal formatting descriptors.- Returns:
- the format.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
detailMessage
public final java.lang.String detailMessage()
Description copied from interface:FormatValidator
A detail message ifFormatValidator.isValid()
returnsfalse
, otherwise an empty string.- Specified by:
detailMessage
in interfaceFormatValidator
- Returns:
- a detailed message.
-
summaryMessage
public final java.lang.String summaryMessage()
Description copied from interface:FormatValidator
A summary message ifFormatValidator.isValid()
returnsfalse
, otherwise an empty string.- Specified by:
summaryMessage
in interfaceFormatValidator
- Returns:
- a summary message.
-
-