net.sf.layoutParser.to

Class EntryTO<T>

java.lang.Object

net.sf.layoutParser.to.BaseNameSpaceTO

net.sf.layoutParser.to.EntryTO<T>

All Implemented Interfaces:

Serializable, Comparable<BaseNameSpaceTO>

Direct Known Subclasses:

ItemTO, ListTO

public abstract class EntryTO<T>
extends BaseNameSpaceTO
implements Serializable

Carries the configuration for a single item in the layout, instructing the framework on how that piece of data must be read or written to the file.

Since:

1.1

Author:

Mário Valentim Junior

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<T>	type

Constructor Summary

Constructors

Constructor and Description
EntryTO()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(BaseNameSpaceTO that)
String	getFiller() The filler to be used with the data if it is needed to supplement the data so that it occupies the full size.
int	getIndex() The index of the entry in the layout allowing to position the entry relative to the rest of the entries.
int	getSize() The max size that the entry must occupy in the layout.
Class<T>	getType() The java type to be created from the parsed string from the file.
TypeHandler<?>	getTypeHandler() The type handler to be used with this entry, it overrides more general type handlers if present.
void	setFiller(String filler) The filler to be used with the data if it is needed to supplement the data so that it occupies the full size.
void	setIndex(int index) The index of the entry in the layout allowing to position the entry relative to the rest of the entries.
void	setSize(int size) The max size that the entry must occupy in the layout.
void	setType(Class<T> type) The java type to be created from the parsed string from the file.
void	setTypeHandler(TypeHandler<T> typeHandler) The type handler to be used with this entry, it overrides more general type handlers if present.

Methods inherited from class net.sf.layoutParser.to.BaseNameSpaceTO

equals, equivalent, getFullName, getFullName, getNamePrefix, getNameSufix, getVersion, hasFullName, hashCode, setNamePrefix, setNameSufix, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

type

protected Class<T> type

Constructor Detail

EntryTO

public EntryTO()

Method Detail

getIndex

public int getIndex()

The index of the entry in the layout allowing to position the entry relative to the rest of the entries.

Returns:

The index of the entry in the layout.

setIndex

public void setIndex(int index)

The index of the entry in the layout allowing to position the entry relative to the rest of the entries.

Parameters:

index - The index of the entry in the layout.

getSize

public int getSize()

The max size that the entry must occupy in the layout.

Returns:

The max size that the entry must occupy in the layout.

setSize

public void setSize(int size)

The max size that the entry must occupy in the layout.

Parameters:

size - The max size that the entry must occupy in the layout.

getFiller

public String getFiller()

The filler to be used with the data if it is needed to supplement the data so that it occupies the full size.

Returns:

The filler to be used if the data is smaller than size.

setFiller

public void setFiller(String filler)

The filler to be used with the data if it is needed to supplement the data so that it occupies the full size.

Parameters:

The - filler to be used if the data is smaller than size.

getType

public Class<T> getType()

The java type to be created from the parsed string from the file.

Returns:

The java type to be created from the parsed string from the file.

setType

public void setType(Class<T> type)

The java type to be created from the parsed string from the file.

Parameters:

type - The java type to be created from the parsed string from the file.

getTypeHandler

public TypeHandler<?> getTypeHandler()

The type handler to be used with this entry, it overrides more general type handlers if present.

Returns:

The type handler to be used with this item.

setTypeHandler

public void setTypeHandler(TypeHandler<T> typeHandler)

The type handler to be used with this entry, it overrides more general type handlers if present.

Parameters:

typeHandler - The type handler to be used with this item.

compareTo

public int compareTo(BaseNameSpaceTO that)

Specified by:

compareTo in interface Comparable<BaseNameSpaceTO>

Overrides:

compareTo in class BaseNameSpaceTO