com.day.cq.contentbus

Interface Atom

All Superinterfaces:

ContentElement

public interface Atom
extends ContentElement

The Atom class represents the smallest content entity. It extends the ContentElement by methods that allow read and write access to the contentbus.

Since:

antbear

Method Summary

Methods

Modifier and Type	Method and Description
double	getNumber() Get the number representation of the atom value throwing exceptions if an error occurrs.
AtomStatus	getStat() Gets the status of an atom.
java.io.InputStream	getStream() Gets a inputstream of the content of the atom or null if the atom is empty.
java.lang.String	getString() Returns the string of the content of the atom.
Value	getValue() Returns the internal value of the content or null if the atom is empty.
boolean	hasContent() Indicates, if the atom has content.
boolean	isBinary() Returns the information if the content is, or could be, in binary format.
boolean	isReadOnly() Returns if this atom is defined as read only.
void	setStream(java.io.InputStream value) Sets the content of the atom by passing a InputStream.
void	setString(java.lang.String value) Writes a string content to the atom.
void	setValue(Value value) Sets the internal value of the atom.
double	toNumber() Get the number representation of the atom value.
java.lang.String	toString() Return the string of the content of the atom.

Methods inherited from interface com.day.cq.contentbus.ContentElement

accept, clear, copyTo, getDeepElement, getDeepElement, getElement, getLabel, getModificationTime, getQualident, getUUID, hasElement, isEmpty, parent

Method Detail

toString

java.lang.String toString()

Return the string of the content of the atom. If the atom is empty or if an error occurres, an empty string is returned.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the content

See Also:

getString(), ContentElement.isEmpty()

getString

java.lang.String getString()
                           throws ContentBusException

Returns the string of the content of the atom. If the atom is empty, an empty string is returned. In despite of the toString(), an exception can be thrown, if an error occures.

Returns:

a string representation of the content of the atom

Throws:

ContentBusException - if error occurs.

See Also:

toString(), ContentElement.isEmpty()

setString

void setString(java.lang.String value)
               throws ContentBusException

Writes a string content to the atom. At the time this method is called, the page this atom belongs to, must be in a transaction. If this atom is defined as read only, this call has no effect.

Parameters:

value - the string

Throws:

ContentBusException - if the content can't be stored in the atom

java.lang.IllegalStateException - if the page of this atom is not ina transaction

See Also:

setValue(Value), Page.startTransaction(), Page.commit()

getNumber

double getNumber()
                 throws ContentBusException,
                        java.lang.NumberFormatException

Get the number representation of the atom value throwing exceptions if an error occurrs. Note that the number is a double so if the original was a long, some accuracy may be lost. In despite of the toNumber(), an exception can be thrown, if an error occurs.

Returns:

the numeric representation of the value or Double.NaN is the atom is empty.

Throws:

ContentBusException - if an error occurs during content access

java.lang.NumberFormatException - if the content can't be converted to a double

See Also:

ContentElement.isEmpty(), toNumber()

toNumber

double toNumber()

Get the number representation of the atom value. If the atom is empty or if an error during content access or conversion occures, a Double.NaN is returned.

Returns:

the numeric representation of the value or Double.NaN if the atom is empty or if an error occurred.

See Also:

ContentElement.isEmpty(), getNumber()

getStream

java.io.InputStream getStream()
                              throws ContentBusException

Gets a inputstream of the content of the atom or null if the atom is empty.

Returns:

a stream of the content or null if empty.

Throws:

ContentBusException - if an error during content access occurred.

See Also:

ContentElement.isEmpty()

setStream

void setStream(java.io.InputStream value)
               throws ContentBusException

Sets the content of the atom by passing a InputStream. The actualy reading of the stream is not done until the writeback of the atom. At the time this method is called, the page this atom belongs to, must be in a transaction. If this atom is defined as read only, this call has no effect.

Parameters:

value - a stream containing content

Throws:

ContentBusException - if an error during content access occurres

java.lang.IllegalStateException - if the page of this atom is not in a transaction.

See Also:

setValue(Value), Page.startTransaction(), Page.commit()

getValue

Value getValue()
               throws ContentBusException

Returns the internal value of the content or null if the atom is empty.

Returns:

the internal value

Throws:

ContentBusException - if an error during content access occurres.

See Also:

ContentElement.isEmpty()

setValue

void setValue(Value value)
              throws ContentBusException

Sets the internal value of the atom. The actualy reading of the value is not done until the writeback of the atom. At the time this method is called, the page this atom belongs to, must be in a transaction. If this atom is defined as read only, this call has no effect.

Parameters:

value - the value to store

Throws:

ContentBusException - if an error during content access occurres

java.lang.IllegalStateException - if the page of this atom is not in a transaction.

See Also:

Page.startTransaction(), Page.commit()

getStat

AtomStatus getStat()
                   throws ContentBusException

Gets the status of an atom.

Returns:

the status of the atom

Throws:

ContentBusException - if an error occurres

isBinary

boolean isBinary()
                 throws ContentBusException

Returns the information if the content is, or could be, in binary format. This information is actually independent of the actual content, but is rather defined by the CSD.

Returns:

true if the value is binary; false otherwise.

Throws:

ContentBusException - if an error occurres

hasContent

boolean hasContent()
                   throws ContentBusException

Indicates, if the atom has content. This is always the opposite of ContentElement.isEmpty().

Returns:

true if the atom has content; false otherwise.

Throws:

ContentBusException - if an error occurres

isReadOnly

boolean isReadOnly()

Returns if this atom is defined as read only.

Returns:

true if this atom is defined as read only; false otherwise.