Module com.aoapps.html.any

Package com.aoapps.html.any

Class Attributes

java.lang.Object

com.aoapps.html.any.Attributes

public final class Attributes
extends Object

See HTML Attributes.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Attributes.Boolean	See 2.4.2 Boolean attributes.
static final class	Attributes.Dimension	See 2.4.4.4 Percentages and lengths.
static final class	Attributes.Event	See HTML Event Attributes.
static @interface	Attributes.Funnel	Marks a method as being an attribute funnel to aid in implementation.
static final class	Attributes.Integer	See 2.4.4.1 Signed integers.
static final class	Attributes.String	Non-streamable text attributes (expected to be short, relatively fixed values).
static final class	Attributes.Text	Streamable text attributes.
static final class	Attributes.Url	URL attributes.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NO_VALUE	Special value used in-place of return values that should result in an empty attribute (expected on Serialization.SGML only).
static final Resources	RESOURCES

Method Summary

Modifier and Type	Method	Description
static ValidationResult	invalidGlobalAttributeForDoctype(Element<?,?,?> element, Doctype requiredDoctype, String attrName)	Enforces that the document type is correct for the given global attribute.
static void	onlySupportedInHtml5(AnyDocument<?> document, String attrName)	Enforces that the document type is HTML 5 for the given attribute.
static <T, Ex extends Throwable> T	validate(T value, FunctionE<? super T,ValidationResult,Ex> validator)	Validates a value using the provided validator.
static <T, Ex extends Throwable> T	validate(T value, ValidationResult validationResult)	Checks a validation result.
static ValidationResult	validateInHtml5(AnyDocument<?> document, String attrName)	Validates that the document type is HTML 5 for the given attribute.
static ValidationResult	validateInHtml5(Element<?,?,?> element, String attrName)	Validates that the document type is HTML 5 for the given attribute.

Methods inherited from class java.lang.Object

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

Field Details

RESOURCES

public static final Resources RESOURCES

NO_VALUE

public static final String NO_VALUE

Special value used in-place of return values that should result in an empty attribute (expected on Serialization.SGML only). This distinguishes from a return value of null, which causes the attribute to not be added at all.

In order to never conflict with an actual attribute value, this string is compared by identity, not by value.

Method Details

validate

public static <T,
Ex extends Throwable> T validate(T value,
 ValidationResult validationResult)
                                            throws IllegalArgumentException,
Ex

Checks a validation result.

Returns:

The value when valid

Throws:

IllegalArgumentException - When invalid, supporting LocalizedIllegalArgumentException when validationResult is an InvalidResult

Ex

validate

public static <T,
Ex extends Throwable> T validate(T value,
 FunctionE<? super T,ValidationResult,Ex> validator)
                                            throws IllegalArgumentException,
Ex

Validates a value using the provided validator.

Parameters:

validator - When null, no validation is performed.

Returns:

The value when valid

Throws:

IllegalArgumentException - When invalid, supporting LocalizedIllegalArgumentException when validationResult is an InvalidResult

Ex

validateInHtml5

public static ValidationResult validateInHtml5(AnyDocument<?> document,
 String attrName)

Validates that the document type is HTML 5 for the given attribute.

validateInHtml5

public static ValidationResult validateInHtml5(Element<?,?,?> element,
 String attrName)

Validates that the document type is HTML 5 for the given attribute.

onlySupportedInHtml5

public static void onlySupportedInHtml5(AnyDocument<?> document,
 String attrName)
                                 throws UnsupportedOperationException

Enforces that the document type is HTML 5 for the given attribute.

Throws:

UnsupportedOperationException - when EncodingContext.getDoctype() is not Doctype.HTML5.

invalidGlobalAttributeForDoctype

public static ValidationResult invalidGlobalAttributeForDoctype(Element<?,?,?> element,
 Doctype requiredDoctype,
 String attrName)

Enforces that the document type is correct for the given global attribute.

Throws:

UnsupportedOperationException - when EncodingContext.getDoctype() is not Doctype.HTML5.