com.github.mangstadt.vinnie.validate

Class VObjectValidator

java.lang.Object

com.github.mangstadt.vinnie.validate.VObjectValidator

public class VObjectValidator
extends Object

Checks properties for illegal characters.

Two kinds of checking are supported: strict and non-strict. Strict ensures that the data adhere to the specifications. Non-strict allows all characters to be used, as long as they do not break the syntax.

Example:

 SyntaxStyle style = SyntaxStyle.NEW;
 String name = "NOTE #2";
 
 boolean strict = false;
 assertTrue(VObjectValidator.validatePropertyName(name, style, strict));
 
 strict = true;
 assertFalse(VObjectValidator.validatePropertyName(name, style, strict));
 

Author:

Michael Angstadt

Method Summary

Modifier and Type	Method and Description
static AllowedCharacters	allowedCharactersGroup(SyntaxStyle syntax, boolean strict) Gets the list of allowed characters for group names.
static AllowedCharacters	allowedCharactersParameterName(SyntaxStyle syntax, boolean strict) Gets the list of allowed characters for parameter names.
static AllowedCharacters	allowedCharactersParameterValue(SyntaxStyle syntax, boolean caretEncoding, boolean strict) Gets the list of allowed characters for parameter values.
static AllowedCharacters	allowedCharactersPropertyName(SyntaxStyle syntax, boolean strict) Gets the list of allowed characters for property names.
static boolean	validateGroupName(String group, SyntaxStyle syntax, boolean strict) Validates a group name.
static boolean	validateParameterName(String name, SyntaxStyle syntax, boolean strict) Validates a parameter name.
static boolean	validateParameterValue(String value, SyntaxStyle syntax, boolean caretEncoding, boolean strict) Validates a parameter value.
static boolean	validatePropertyName(String name, SyntaxStyle syntax, boolean strict) Validates a property name.

Methods inherited from class java.lang.Object

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

Method Detail

validatePropertyName

public static boolean validatePropertyName(String name,
                                           SyntaxStyle syntax,
                                           boolean strict)

Validates a property name.

Parameters:

name - the property name

syntax - the syntax style to validate against

strict - false to allow all characters as long as they don't break the syntax, true for spec-compliant validation

Returns:

true if the property name is valid, false if not

allowedCharactersPropertyName

public static AllowedCharacters allowedCharactersPropertyName(SyntaxStyle syntax,
                                                              boolean strict)

Gets the list of allowed characters for property names.

Parameters:

syntax - the syntax style

strict - false for the non-strict list, true for the spec-compliant list

Returns:

the character list

validateGroupName

public static boolean validateGroupName(String group,
                                        SyntaxStyle syntax,
                                        boolean strict)

Validates a group name.

Parameters:

group - the group name

syntax - the syntax style to validate against

strict - false to allow all characters as long as they don't break the syntax, true for spec-compliant validation

Returns:

true if the group name is valid, false if not

allowedCharactersGroup

public static AllowedCharacters allowedCharactersGroup(SyntaxStyle syntax,
                                                       boolean strict)

Gets the list of allowed characters for group names.

Parameters:

syntax - the syntax style

strict - false for the non-strict list, true for the spec-compliant list

Returns:

the character list

validateParameterName

public static boolean validateParameterName(String name,
                                            SyntaxStyle syntax,
                                            boolean strict)

Validates a parameter name.

Parameters:

name - the parameter name

syntax - the syntax style to validate against

strict - false to allow all characters as long as they don't break the syntax, true for spec-compliant validation

Returns:

true if the parameter name is valid, false if not

allowedCharactersParameterName

public static AllowedCharacters allowedCharactersParameterName(SyntaxStyle syntax,
                                                               boolean strict)

Gets the list of allowed characters for parameter names.

Parameters:

syntax - the syntax style

strict - false for the non-strict list, true for the spec-compliant list

Returns:

the character list

validateParameterValue

public static boolean validateParameterValue(String value,
                                             SyntaxStyle syntax,
                                             boolean caretEncoding,
                                             boolean strict)

Validates a parameter value.

Parameters:

value - the parameter value

syntax - the syntax style to validate against

caretEncoding - true if caret encoding is enabled, false if not

strict - false to allow all characters as long as they don't break the syntax, true for spec-compliant validation

Returns:

true if the parameter value is valid, false if not

allowedCharactersParameterValue

public static AllowedCharacters allowedCharactersParameterValue(SyntaxStyle syntax,
                                                                boolean caretEncoding,
                                                                boolean strict)

Gets the list of allowed characters for parameter values.

Parameters:

syntax - the syntax style

caretEncoding - true if caret encoding is enabled, false if not

strict - false for the non-strict list, true for the spec-compliant list

Returns:

the character list