com.comphenix.protocol

Class CommandFilter.Filter

java.lang.Object

com.comphenix.protocol.CommandFilter.Filter

Enclosing class:

CommandFilter

public static class CommandFilter.Filter
extends java.lang.Object

A filter that will be used to process a packet event.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
CommandFilter.Filter(java.lang.String name, java.lang.String predicate, java.util.Set<PacketType> packets) Construct a new immutable filter.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(javax.script.ScriptEngine context) Clean up all associated code from this filter in the provided script engine.
void	compile(javax.script.ScriptEngine context) Force the compilation of a specific filter.
boolean	evaluate(javax.script.ScriptEngine context, PacketEvent event) Evaluate the current filter using the provided ScriptEngine as context.
java.lang.String	getName() Retrieve the unique name of the filter.
java.lang.String	getPredicate() Retrieve the JavaScript predicate that will be used to filter packet events.
java.util.Set<PacketType>	getRanges() Retrieve a copy of the set of packets this filter applies to.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandFilter.Filter

public CommandFilter.Filter(java.lang.String name,
                    java.lang.String predicate,
                    java.util.Set<PacketType> packets)

Construct a new immutable filter.

Parameters:

name - - the unique name of the filter.

predicate - - the JavaScript predicate that will be used to filter packet events.

packets - - a list of packet types this filter applies to.

Method Detail

getName

public java.lang.String getName()

Retrieve the unique name of the filter.

Returns:

Unique name of the filter.

getPredicate

public java.lang.String getPredicate()

Retrieve the JavaScript predicate that will be used to filter packet events.

Returns:

Predicate itself.

getRanges

public java.util.Set<PacketType> getRanges()

Retrieve a copy of the set of packets this filter applies to.

Returns:

Set of packets this filter applies to.

evaluate

public boolean evaluate(javax.script.ScriptEngine context,
               PacketEvent event)
                 throws javax.script.ScriptException

Evaluate the current filter using the provided ScriptEngine as context.

This context may be modified with additional code.

Parameters:

context - - the current script context.

event - - the packet event to evaluate.

Returns:

TRUE to pass this packet event on to the debug listeners, FALSE otherwise.

Throws:

javax.script.ScriptException - If the compilation failed or the filter is not valid.

compile

public void compile(javax.script.ScriptEngine context)
             throws javax.script.ScriptException

Force the compilation of a specific filter.

Parameters:

context - - the current script context.

Throws:

javax.script.ScriptException - If the compilation failed.

close

public void close(javax.script.ScriptEngine context)

Clean up all associated code from this filter in the provided script engine.

Parameters:

context - - the current script context.