org.polliwog.fields
Class BlankField

java.lang.Object
  extended by org.polliwog.fields.AbstractField
      extended by org.polliwog.fields.BlankField

public class BlankField
extends AbstractField

A blank field, this is used to "consume" tokens from the log entry that aren't needed. Note: this class will probably be deprecated in future releases since it will be better to "ignore" the token rather create an object for it.

 Last Modified By: $Author: barrygently $
 Last Modified On: $Date: 2005/07/04 14:00:02 $
 Current Revision: $Revision: 1.3 $
 


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
BlankField()
           
 
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)
          Just fulfilling the contract, does nothing.
 
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

BlankField

public BlankField()
Method Detail

init

public void init(java.util.Map params,
                 java.lang.String value)
Just fulfilling the contract, does nothing.

Specified by:
init in class AbstractField
Parameters:
params - The params.
value - 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.


  Copyright © 2007 Gary Bentley. All Rights Reserved.