Class 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
    • 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
      • DEFAULT_INSTANCE

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

      • TokenMakerFactory

        public TokenMakerFactory()
    • Method Detail

      • 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()