Package parser

Class CustomScannerOld

  • public class CustomScannerOld
extends java.lang.Object
    Since:
    2011 Objects of this class scans a string into tokens based on a list of tokenizer values.
    Author:
    JIBOYE Oluwagbemiro Olaoluwa

    • Constructor Summary

      Constructors 
      Constructor Description
      CustomScannerOld​(java.lang.String input, boolean includeTokensInOutput, java.lang.String... splitterTokens)  
      CustomScannerOld​(java.lang.String input, boolean includeTokensInOutput, java.lang.String[] splitterTokens1, java.lang.String... splitterTokens2)
      A convenience constructor used when there exists more than one array containing the tokenizer data.
      CustomScannerOld​(java.lang.String input, boolean includeTokensInOutput, java.lang.String[] splitterTokens, java.lang.String[] splitterTokens1, java.lang.String... splitterTokens2)
      A convenience constructor used when there exists more than one array containing the tokenizer data.

    • Method Summary

      Modifier and Type Method Description
      void addSplittingToken​(java.lang.String splittingTokens)
      Adds the value specified as the method's argument to its splitting tokens list.
      void addSplittingTokens​(java.lang.String... splittingTokens)
      Adds the values specified in the variable argument list to its splitting tokens list.
      int getFirstTokenIndex()  
      java.util.List<java.lang.String> getFoundTokens()  
      java.lang.String getInput()  
      java.util.List<java.lang.String> getSplittingTokens()  
      boolean isIncludeTokensInOutput()  
      static void main​(java.lang.String[] args)  
      java.util.List<java.lang.String> scan()  
      void setFirstTokenIndex​(int firstTokenIndex)  
      void setIncludeTokensInOutput​(boolean includeTokensInOutput)  
      void setInput​(java.lang.String input)
      Allows the object of this class to be reused over for another input.
      void setSplittingTokens​(java.lang.String... splittingTokens)  
      void setSplittingTokens​(java.lang.String[] splittingTokens, java.lang.String... splittingTokens1)
      Convenience method that takes two parameters, as specified below::
      void setSplittingTokens​(java.util.List<java.lang.String> splittingTokens)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CustomScannerOld

        public CustomScannerOld​(java.lang.String input,
                        boolean includeTokensInOutput,
                        java.lang.String... splitterTokens)
        Parameters:
        input - The input to scan.
        includeTokensInOutput - Will allow the splitting tokens to be added to the final scan if this attribute is set to true.
        splitterTokens - An array of tokens..input as a variable argument list... on which the input is to be split.

      • CustomScannerOld

        public CustomScannerOld​(java.lang.String input,
                        boolean includeTokensInOutput,
                        java.lang.String[] splitterTokens1,
                        java.lang.String... splitterTokens2)
        A convenience constructor used when there exists more than one array containing the tokenizer data.
        Parameters:
        input - The input to scan.
        includeTokensInOutput - Will allow the splitting tokens to be added to the final scan if this attribute is set to true.
        splitterTokens1 - An array of tokens..input as a variable argument list... on which the input is to be split.
        splitterTokens2 - A second array of tokens..input as a variable argument list... on which the input is to be split.

      • CustomScannerOld

        public CustomScannerOld​(java.lang.String input,
                        boolean includeTokensInOutput,
                        java.lang.String[] splitterTokens,
                        java.lang.String[] splitterTokens1,
                        java.lang.String... splitterTokens2)
        A convenience constructor used when there exists more than one array containing the tokenizer data.
        Parameters:
        input - The input to scan.
        includeTokensInOutput - Will allow the splitting tokens to be added to the final scan if this attribute is set to true.
        splitterTokens - An array of tokens on which the input is to be split.
        splitterTokens1 - A second array of tokens on which the input is to be split.
        splitterTokens2 - A second array of tokens..input as a variable argument list... on which the input is to be split.

    • Method Detail

      • getFoundTokens

        public java.util.List<java.lang.String> getFoundTokens()
        Returns:
        an array containing any of the elements in the splittingTokens array that are also present in the input.

      • setFirstTokenIndex

        public void setFirstTokenIndex​(int firstTokenIndex)

      • getFirstTokenIndex

        public int getFirstTokenIndex()

      • setIncludeTokensInOutput

        public void setIncludeTokensInOutput​(boolean includeTokensInOutput)

      • isIncludeTokensInOutput

        public boolean isIncludeTokensInOutput()

      • setInput

        public void setInput​(java.lang.String input)
        Allows the object of this class to be reused over for another input.
        Parameters:
        input - sets the input to be scanned to this one. If a new set of tokens should be used to split this string the user should call method setSplittingTokens after calling this method.

      • getInput

        public java.lang.String getInput()

      • setSplittingTokens

        public void setSplittingTokens​(java.util.List<java.lang.String> splittingTokens)

      • addSplittingTokens

        public void addSplittingTokens​(java.lang.String... splittingTokens)
        Adds the values specified in the variable argument list to its splitting tokens list.
        Parameters:
        splittingTokens - A variable argument list containing values to be added to the splitting tokens list of this scanner.

      • addSplittingToken

        public void addSplittingToken​(java.lang.String splittingTokens)
        Adds the value specified as the method's argument to its splitting tokens list.
        Parameters:
        splittingTokens - A string containing the value to be added to the splitting tokens list of this scanner.

      • setSplittingTokens

        public void setSplittingTokens​(java.lang.String... splittingTokens)
        Parameters:
        splittingTokens - A variable argument list containing values that are to be set as this scanner's tokens to be used for splitting the input. All other splitting tokens specified before making a call to this method are discarded.

      • setSplittingTokens

        public void setSplittingTokens​(java.lang.String[] splittingTokens,
                               java.lang.String... splittingTokens1)
        Convenience method that takes two parameters, as specified below::
        Parameters:
        splittingTokens - An array containing values that are to be set as this scanner's tokens to be used for splitting the input.
        splittingTokens1 - A variable argument list containing more values to be added to the to this scanner's splitting tokens.

      • getSplittingTokens

        public java.util.List<java.lang.String> getSplittingTokens()

      • scan

        public java.util.List<java.lang.String> scan()
        Returns:
        this string split on the operators.

      • main

        public static void main​(java.lang.String[] args)