Class TokenMakerFactory

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

public abstract class TokenMakerFactory extends Object
A factory that maps syntax styles to TokenMakers capable of splitting text into tokens for those syntax styles.
Version:
1.0
  • Field Details

    • PROPERTY_DEFAULT_TOKEN_MAKER_FACTORY

      public static final 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:
    • DEFAULT_INSTANCE

      private static TokenMakerFactory DEFAULT_INSTANCE
      The singleton default TokenMakerFactory instance.
  • Constructor Details

    • TokenMakerFactory

      public TokenMakerFactory()
  • Method Details

    • 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:
    • getTokenMaker

      public final TokenMaker getTokenMaker(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(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 Set<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:
      IllegalArgumentException - If tmf is null.
      See Also: