org.topoweb.ila.protocol
Class PMaxCountAttr

java.lang.Object
  |
  +--org.topoweb.ila.protocol.PMaxCountAttr

All Implemented Interfaces:

ProtocolConstants

public class PMaxCountAttr

extends java.lang.Object

implements ProtocolConstants

Encapsulates the reading and writing of the "max count" attribute. This attribute has a default value (zero) that is worth encapsulating.

Author:

Babak Farhang

See Also:

ProtocolConstants.PC_MAX_COUNT

Field Summary

Fields inherited from interface org.topoweb.ila.protocol.ProtocolConstants

PC_BACKLINK_COUNT, PC_BACKLINKS, PC_CO_BACKLINK_COUNT, PC_CO_FORELINK_COUNT, PC_CONTENT_LENGTH, PC_CONTENT_TYPE, PC_ERROR_CODE, PC_EXPIRATION, PC_FAIL, PC_FIRST, PC_FORELINK_COUNT, PC_FORELINKS, PC_GET_KNOWN, PC_GET_LINK_NODE, PC_GET_LINKS, PC_GET_NODE, PC_HI, PC_HTTP, PC_ID, PC_ILA, PC_INCOMMUNICADO, PC_LAST, PC_LAST_MODIFIED, PC_LINK_NODE, PC_LINK_TYPE, PC_LO, PC_MAX_COUNT, PC_NODE, PC_NODE_SET, PC_OKAY, PC_ORI, PC_PAGE, PC_REGISTER, PC_REQUEST, PC_RESPONSE, PC_SIZE, PC_STATE, PC_STATUS, PC_SYNC_VERSION_ID, PC_SYNC_VERSION_TIMESTAMP, PC_TITLE, PC_USER, PC_USER_AGENT, PC_USER_NAMESPACE, PC_VERSION, PC_VERSION_ID, PC_VERSION_TIMESTAMP

Constructor Summary

PMaxCountAttr()

Method Summary

int	readMaxCount(org.w3c.dom.Element func) Reads and returns the "max count" from the given element.
void	writeMaxCount(int maxCount, org.w3c.dom.Element func) Writes the given maxCount value in the given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

PMaxCountAttr

public PMaxCountAttr()

Method Detail

writeMaxCount

public void writeMaxCount(int maxCount,
                          org.w3c.dom.Element func)
                   throws java.lang.IllegalArgumentException

Writes the given maxCount value in the given element. If maxCount is <= 0, no attribute is written.

Parameters:

maxCount - the max count

func - the element into which the attribute is written into

java.lang.IllegalArgumentException

readMaxCount

public int readMaxCount(org.w3c.dom.Element func)
                 throws IlaProtocolException

Reads and returns the "max count" from the given element. Note that if the given func element has no "max count" attribute then the default (zero) is assumed.

Parameters:

func - the element from which the "max count" attribute will be read

Returns:

a number gt;= 0

Throws:

IlaProtocolException - if there is an error