org.kefirsf.bb.proc

Class ProcCode

java.lang.Object

org.kefirsf.bb.proc.ProcCode

All Implemented Interfaces:

Comparable<ProcCode>

public class ProcCode
extends Object
implements Comparable<ProcCode>

The bbcode class

Author:

Kefir

Constructor Summary

Constructors

Constructor and Description
ProcCode(List<ProcPattern> patterns, ProcTemplate template, String name, int priority, boolean transparent) Create the bb-code with priority

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ProcCode code) Compare by priorities
boolean	containsCheck()
boolean	equals(Object o)
int	hashCode()
boolean	process(Context context) Parse bb-code Before invocation suspicious method must be call
boolean	startsWithConstant()
boolean	suspicious(Context context) Check if next sequence can be parsed with this code.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcCode

public ProcCode(List<ProcPattern> patterns,
        ProcTemplate template,
        String name,
        int priority,
        boolean transparent)

Create the bb-code with priority

Parameters:

patterns - pattern to parse the source text

template - template to build target text

name - name of code

priority - priority. If priority higher then code be checking early.

transparent - Do show variables outside the code?

Method Detail

process

public boolean process(Context context)
                throws org.kefirsf.bb.proc.NestingException

Parse bb-code Before invocation suspicious method must be call

Parameters:

context - the bb-processing context

Returns:

true - if parse source false - if can't parse code

Throws:

NestingException - if nesting is too big.

suspicious

public boolean suspicious(Context context)

Check if next sequence can be parsed with this code. It's most called method in this project.

Parameters:

context - current context

Returns:

true - if next sequence can be parsed with this code; false - only if next sequence can't be parsed with this code.

compareTo

public int compareTo(ProcCode code)

Compare by priorities

Specified by:

compareTo in interface Comparable<ProcCode>

startsWithConstant

public boolean startsWithConstant()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

containsCheck

public boolean containsCheck()