leafchat.core.api
Class FilterInfo

java.lang.Object
  extended by leafchat.core.api.FilterInfo

public class FilterInfo
extends java.lang.Object

Metadata about a particular message filter type.


Nested Class Summary
static class FilterInfo.Parameter
          Stores information about a parameter to the filter constructor.
 
Constructor Summary
FilterInfo(java.lang.Class<? extends MessageFilter> c)
          Constructs with a particular filter class and a default name (the class name without Filter).
FilterInfo(java.lang.Class<? extends MessageFilter> c, java.lang.String name)
          Constructs with a particular filter class.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.Class<? extends MessageFilter> getFilterClass()
           
 java.lang.String getName()
           
 FilterInfo.Parameter[] getScriptingParameters()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterInfo

public FilterInfo(java.lang.Class<? extends MessageFilter> c)
Constructs with a particular filter class and a default name (the class name without Filter).

Parameters:
c - Class of filter to which this info applies

FilterInfo

public FilterInfo(java.lang.Class<? extends MessageFilter> c,
                  java.lang.String name)
Constructs with a particular filter class.

Parameters:
c - Class of filter to which this info applies
name - Display name for filter
Method Detail

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
Parameters:
obj - Comparison object
Returns:
True if the object is a FilterInfo referring to same class

getFilterClass

public java.lang.Class<? extends MessageFilter> getFilterClass()
Returns:
Class of filter

getName

public final java.lang.String getName()
Returns:
Display name

getScriptingParameters

public FilterInfo.Parameter[] getScriptingParameters()
Returns:
A list of parameters for the constructor to use when scripting, or null if the filter does not support scripting.


Copyright © 2011 Samuel Marshall. All rights reserved.