Package com.nomagic.magicreport.engine

Class ITool.HTMLString

java.lang.Object

com.nomagic.magicreport.engine.ITool.HTMLString

All Implemented Interfaces:

IVariable, Serializable, CharSequence

Enclosing interface:

ITool

@OpenApiAll
public static class ITool.HTMLString
extends Object
implements CharSequence, IVariable

Direct command IFormatter to render in HTML format.

Since:

Sep 04, 2008

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HTMLString(CharSequence charSequence)	Constructs a retained string that contains the same characters as the specified CharSequence.

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)	Returns the char value at the specified index.
boolean	equals(Object anObject)	Compares this HTMLString to the specified object.
int	hashCode()	Returns a hash code for this HTMLString.
int	length()	Returns the length of this character sequence.
CharSequence	subSequence(int start, int end)	Returns a new CharSequence that is a subsequence of this sequence.
String	toString()	Returns a string containing the characters in this sequence in the same order as this sequence.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty

Constructor Details

HTMLString

public HTMLString(CharSequence charSequence)

Constructs a retained string that contains the same characters as the specified CharSequence.

Parameters:

charSequence - the sequence to copy.

Method Details

charAt

public char charAt(int index)

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Specified by:

charAt in interface CharSequence

Parameters:

index - the index of the char value to be returned

Returns:

the specified char value

Throws:

IndexOutOfBoundsException - if the index argument is negative or not less than length()

See Also:

• CharSequence.charAt(int)

length

public int length()

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Specified by:

length in interface CharSequence

Returns:

the number of chars in this sequence

See Also:

• CharSequence.length()

subSequence

public CharSequence subSequence(int start,
 int end)

Returns a new CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Specified by:

subSequence in interface CharSequence

Parameters:

start - the start index, inclusive

end - the end index, exclusive

Returns:

the specified subsequence

Throws:

IndexOutOfBoundsException - if start or end are negative, if end is greater than length(), or if start is greater than end

See Also:

• CharSequence.subSequence(int, int)

toString

public String toString()

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

a string consisting of exactly this sequence of characters

equals

public boolean equals(Object anObject)

Compares this HTMLString to the specified object. The result is true if and only if the argument is not null and is a HTMLString object that represents the same sequence of characters as this object.

Overrides:

equals in class Object

Parameters:

anObject - The object to compare this HTMLString against

Returns:

true if the given object represents a HTMLString equivalent to this HTMLString, false otherwise

hashCode

public int hashCode()

Returns a hash code for this HTMLString.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.