org.fife.ui.rsyntaxtextarea
Class TokenMakerFactory

java.lang.Object
  extended by org.fife.ui.rsyntaxtextarea.TokenMakerFactory
Direct Known Subclasses:
AbstractTokenMakerFactory

public abstract class TokenMakerFactory
extends java.lang.Object

A factory that maps syntax styles to TokenMakers capable of splitting text into tokens for those syntax styles.

Version:
1.0
Author:
Robert Futrell

Field Summary
static java.lang.String PROPERTY_DEFAULT_TOKEN_MAKER_FACTORY
          If this system property is set, a custom TokenMakerFactory of the specified class will be used as the default token maker factory.
 
Constructor Summary
TokenMakerFactory()
           
 
Method Summary
static TokenMakerFactory getDefaultInstance()
          Returns the default TokenMakerFactory instance.
 TokenMaker getTokenMaker(java.lang.String key)
          Returns a TokenMaker for the specified key.
protected abstract  TokenMaker getTokenMakerImpl(java.lang.String key)
          Returns a TokenMaker for the specified key.
abstract  java.util.Set<java.lang.String> keySet()
          Returns the set of keys that this factory maps to token makers.
static void setDefaultInstance(TokenMakerFactory tmf)
          Sets the default TokenMakerFactory instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_DEFAULT_TOKEN_MAKER_FACTORY

public static final java.lang.String PROPERTY_DEFAULT_TOKEN_MAKER_FACTORY
If this system property is set, a custom TokenMakerFactory of the specified class will be used as the default token maker factory.

See Also:
Constant Field Values
Constructor Detail

TokenMakerFactory

public TokenMakerFactory()
Method Detail

getDefaultInstance

public static TokenMakerFactory getDefaultInstance()
Returns the default TokenMakerFactory instance. This is the factory used by all RSyntaxDocuments by default.

Returns:
The factory.
See Also:
setDefaultInstance(TokenMakerFactory)

getTokenMaker

public final TokenMaker getTokenMaker(java.lang.String key)
Returns a TokenMaker for the specified key.

Parameters:
key - The key.
Returns:
The corresponding TokenMaker, or PlainTextTokenMaker if none matches the specified key.

getTokenMakerImpl

protected abstract TokenMaker getTokenMakerImpl(java.lang.String key)
Returns a TokenMaker for the specified key.

Parameters:
key - The key.
Returns:
The corresponding TokenMaker, or null if none matches the specified key.

keySet

public abstract java.util.Set<java.lang.String> keySet()
Returns the set of keys that this factory maps to token makers.

Returns:
The set of keys.

setDefaultInstance

public static void setDefaultInstance(TokenMakerFactory tmf)
Sets the default TokenMakerFactory instance. This is the factory used by all future RSyntaxDocuments by default. RSyntaxDocuments that have already been created are not affected.

Parameters:
tmf - The factory.
Throws:
java.lang.IllegalArgumentException - If tmf is null.
See Also:
getDefaultInstance()