org.josef.web.html

Class HtmlAttribute

java.lang.Object

org.josef.web.html.HtmlAttribute

public class HtmlAttribute
extends Object

Represents an HTML attribute, like: id, for example.

Version:

1.0 $Revision: 5772 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
HtmlAttribute(HtmlAttribute sourceAttribute) Copy constructor, constructs a new HTML attribute from the supplied sourceAttribute.
HtmlAttribute(String name) Constructs this HTML attribute from the supplied name.
HtmlAttribute(String name, String value) Constructs this HTML attribute from the supplied name and value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object htmlAttribute) Determines if the supplied htmlAttribute is equal to this HtmlAttribute.
String	getName() Gets the name of this HTML attribute.
String	getValue() Gets the value of this HTML attribute.
int	hashCode() Computes the hash code of this HtmlAttribute.
String	toHtml() Creates an HTML representation of this HTML attribute.
String	toString() Creates a String representation of this HTML attribute.
static void	validateAttributeName(String name) Validates if the supplied name is a valid HTML attribute name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HtmlAttribute

public HtmlAttribute(String name)

Constructs this HTML attribute from the supplied name.

Parameters:

name - The name of this HTML attribute.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty or not valid.
The name of an attribute may not contain the "<" character for example.

HtmlAttribute

public HtmlAttribute(String name,
                     String value)

Constructs this HTML attribute from the supplied name and value.

Parameters:

name - The name of this HTML attribute.

value - The value of this HTML attribute.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty or not valid.
The name of an attribute may not contain the "<" character for example.

HtmlAttribute

public HtmlAttribute(HtmlAttribute sourceAttribute)

Copy constructor, constructs a new HTML attribute from the supplied sourceAttribute.

Parameters:

sourceAttribute - The source to create a new HTML attribute from.

Method Detail

validateAttributeName

public static void validateAttributeName(String name)

Validates if the supplied name is a valid HTML attribute name.
The first character must be a letter from a to z or A to Z. Optional additional characters must be letters, digits or the symbols "-" or "*".

Parameters:

name - The name of the HTML attribute to verify.

Throws:

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty or contains an illegal character.

getName

public String getName()

Gets the name of this HTML attribute.

Returns:

The name of this HTML attribute.

getValue

public String getValue()

Gets the value of this HTML attribute.

Returns:

The value of this HTML attribute.

toHtml

public String toHtml()

Creates an HTML representation of this HTML attribute.
The format of the String is: name[="value"].

Returns:

An HTML representation of this HTML attribute.

hashCode

public int hashCode()

Computes the hash code of this HtmlAttribute.
Since you can normally have at most one attribute with the same name, the value of the attribute is not used.

Overrides:

hashCode in class Object

Returns:

The hash code of this HtmlAttribute.

equals

public boolean equals(Object htmlAttribute)

Determines if the supplied htmlAttribute is equal to this HtmlAttribute.
Two attributes are considered equal if the supplied htmlAttribute has the same name as this HtmlAttribute.

Overrides:

equals in class Object

Returns:

True if the supplied htmlAttribute is equal to this HtmlAttribute.

toString

public String toString()

Creates a String representation of this HTML attribute.
The format of the String is: name[=value].

Overrides:

toString in class Object

Returns:

A String representation of this HTML attribute.