Interface WildcardMatcher

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getWildcardNames​()
      Retrieves the list of wildcard names identifying the wildcards as specified by the pattern.
      java.lang.String toWildcardReplacement​(java.lang.String aText, java.lang.String aWildcardName)
      Returns the wildcard substitute for the wildcards in your pattern compared to the actual text.
      java.lang.String toWildcardReplacementAt​(java.lang.String aText, int aIndex)
      Returns the wildcard substitute for the wildcards in your pattern compared to the actual text (as of toWildcardSubstitutes(String)).
      java.lang.String[] toWildcardReplacements​(java.lang.String aText)
      Returns an array of the wildcard substitutes for the wildcards in your pattern compared to the actual text (as of toWildcardSubstitutes(String)).
      java.lang.String[] toWildcardReplacements​(java.lang.String aText, java.lang.String... aWildcardNames)
      Returns the wildcard substitutes for the wildcards in your pattern compared to the actual text .
      java.lang.String[] toWildcardReplacementsAt​(java.lang.String aText, int... aIndexes)
      Returns the wildcard substitutes for the wildcards in your pattern compared to the actual text.
      WildcardSubstitutes toWildcardSubstitutes​(java.lang.String aText)
      Returns all available wildcard substitutes as well as the named wildcard substitutes.
    • Method Detail

      • toWildcardSubstitutes

        WildcardSubstitutes toWildcardSubstitutes​(java.lang.String aText)
        Returns all available wildcard substitutes as well as the named wildcard substitutes.
        Parameters:
        aText - Tex textfor which to retrieve the wildcard substitutes.
        Returns:
        The WildcardSubstitutes of the wildcards being substituted.
      • toWildcardReplacements

        java.lang.String[] toWildcardReplacements​(java.lang.String aText)
        Returns an array of the wildcard substitutes for the wildcards in your pattern compared to the actual text (as of toWildcardSubstitutes(String)). The order of the wildcard substitutes aligns to the order of the wildcards (from left to right) defined in your pattern.
        Parameters:
        aText - Tex textfor which to retrieve the wildcard substitutes.
        Returns:
        The text substituting the wildcards in the order of the wildcards being substituted or null if there are none such substitutes.
      • toWildcardReplacementAt

        java.lang.String toWildcardReplacementAt​(java.lang.String aText,
                                                 int aIndex)
        Returns the wildcard substitute for the wildcards in your pattern compared to the actual text (as of toWildcardSubstitutes(String)). The text of the wildcard substitute aligns to the index of the wildcard (from left to right) as defined in your pattern.
        Parameters:
        aText - Tex textfor which to retrieve the wildcard substitutes.
        aIndex - The index of the wildcard in question for which to retrieve the substitute.
        Returns:
        The text substituting the wildcard at the given pattern's wildcard index or null if there is none such substitute.
      • toWildcardReplacementsAt

        java.lang.String[] toWildcardReplacementsAt​(java.lang.String aText,
                                                    int... aIndexes)
        Returns the wildcard substitutes for the wildcards in your pattern compared to the actual text. The text of the wildcard substitutes aligns to the indexes of the wildcard (from left to right) as defined in your pattern.
        Parameters:
        aText - Tex textfor which to retrieve the wildcard substitutes.
        aIndexes - The indexes of the wildcards in question for which to retrieve the substitutes.
        Returns:
        The text substituting the wildcards at the given pattern's wildcard indexes or null if there is none such substitute.
      • toWildcardReplacement

        java.lang.String toWildcardReplacement​(java.lang.String aText,
                                               java.lang.String aWildcardName)
        Returns the wildcard substitute for the wildcards in your pattern compared to the actual text. The text of the wildcard substitute aligns to the name of the wildcard (as defined in your pattern).
        Parameters:
        aText - Tex textfor which to retrieve the wildcard substitutes.
        aWildcardName - The name of the wildcard in question for which to retrieve the substitute.
        Returns:
        The text substituting the wildcard with the given pattern's wildcard name or null if there is none such substitute.
      • toWildcardReplacements

        java.lang.String[] toWildcardReplacements​(java.lang.String aText,
                                                  java.lang.String... aWildcardNames)
        Returns the wildcard substitutes for the wildcards in your pattern compared to the actual text . The text of the wildcard substitutes aligns to the order of the provided wildcard names (as defined in your pattern).
        Parameters:
        aText - Tex textfor which to retrieve the wildcard substitutes.
        aWildcardNames - The names of the wildcards in question for which to retrieve the substitutes in the order of the provided names.
        Returns:
        The text substituting the wildcard with the given pattern's wildcard names or null if there are none such substitute.
      • getWildcardNames

        java.lang.String[] getWildcardNames​()
        Retrieves the list of wildcard names identifying the wildcards as specified by the pattern.
        Returns:
        The wild card names or null of no wild card names have been defined.