Module jamal.api

Interface Delimiters

  • All Known Subinterfaces:
    MacroRegister

    public interface Delimiters
    Simple macro delimiter string storage interface.

    The implementing classes store the actual macro open and macro close strings and provide means to alter the actual values.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String close()  
      java.lang.String open()  
      void separators​(java.lang.String openDelimiter, java.lang.String closeDelimiter)
      Sets the opening and closing delimiter strings, or implementation may reset some old value if the arguments are null
    • Method Detail

      • open

        java.lang.String open()
        Returns:
        the current macro opening string.
      • close

        java.lang.String close()
        Returns:
        the current macro closing string
      • separators

        void separators​(java.lang.String openDelimiter,
                        java.lang.String closeDelimiter)
                 throws BadSyntax
        Sets the opening and closing delimiter strings, or implementation may reset some old value if the arguments are null
        Parameters:
        openDelimiter - the macro opening string to be set. If this parameter is null then the implementation may treat this information as a restore process. For example the class MacroRegister saves the old values of the separators in a stack and when openDelimiter is null it restores the delimiters from the top of the stack.
        closeDelimiter - the macro closing string to be set
        Throws:
        BadSyntaxAt - in case the separators can not be set.
        BadSyntax