org.polliwog.fields
Class UserField

java.lang.Object
  org.polliwog.fields.AbstractField
      org.polliwog.fields.UserField

public class UserField
extends AbstractField

Field Summary

static int

FIELD_ID This is a unique constant for this field, it MUST NOT clash with any other field constant value otherwise incorrect casting may result.

Constructor Summary

UserField()

Method Summary

void	clear() Clear the data that the field holds.
int	getFieldId() Should return a unique id for this field, this is to help with classes (such as: Hit) that use this id to help in identification.
void	init(java.util.Map params, java.lang.String value) The init method.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ID

public static final int FIELD_ID

This is a unique constant for this field, it MUST NOT clash with any other field constant value otherwise incorrect casting may result.

See Also:

Constant Field Values

Constructor Detail

UserField

public UserField()

Method Detail

init

public void init(java.util.Map params,
                 java.lang.String value)
          throws WeblogException

Description copied from class: AbstractField

The init method.

Specified by:

init in class AbstractField

Parameters:

params - A Map of name/value pairs that are used to init the field.

value - The value of the field.

Throws:

WeblogException - Throw if something is wrong with the value.

clear

public void clear()

Description copied from class: AbstractField

Clear the data that the field holds.

Specified by:

clear in class AbstractField

getFieldId

public int getFieldId()

Description copied from class: AbstractField

Should return a unique id for this field, this is to help with classes (such as: Hit) that use this id to help in identification.

Specified by:

getFieldId in class AbstractField

Returns:

A unique id.