Module org.refcodes.mixin
Package org.refcodes.mixin

Interface WildcardSubstitutes

public interface WildcardSubstitutes
The WildcardSubstitutes contains all information available regarding substitution of wildcards in path declarations.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getWildcardNames()
    Retrieves the array of wildcard names (aliases) in this instance.
    String
    getWildcardReplacement(String aWildcardName)
    Returns the wildcard substitute for the wildcards in your path pattern compared to the actual path.
    String
    getWildcardReplacementAt(int aIndex)
    Returns the wildcard substitute for the wildcards in your path pattern compared to the actual path.
    String[]
    getWildcardReplacements()
    Returns an array of the wildcard substitutes for the wildcards in your path pattern compared to the actual path.
    String[]
    getWildcardReplacements(String... aWildcardNames)
    Returns the wildcard substitutes for the wildcards in your path pattern compared to the actual path.
    String[]
    getWildcardReplacementsAt(int... aIndexes)
    Returns the wildcard substitutes for the wildcards in your path pattern compared to the actual path.

  • Method Details

    • getWildcardReplacements

      String[] getWildcardReplacements()
      Returns an array of the wildcard substitutes for the wildcards in your path pattern compared to the actual path. The order of the wildcard substitutes aligns to the order of the wildcards (from left to right) defined in your path pattern.
      Returns:
      The text substituting the wildcards in the order of the wildcards being substituted or null if there are none such substitutes.

    • getWildcardReplacementAt

      String getWildcardReplacementAt(int aIndex)
      Returns the wildcard substitute for the wildcards in your path pattern compared to the actual path. The text of the wildcard substitute aligns to the index of the wildcard (from left to right) as defined in your path pattern.
      Parameters:
      aIndex - The index of the wildcard in question for which to retrieve the substitute.
      Returns:
      The text substituting the wildcard at the given path pattern's wildcard index or null if there is none such substitute.

    • getWildcardReplacementsAt

      String[] getWildcardReplacementsAt(int... aIndexes)
      Returns the wildcard substitutes for the wildcards in your path pattern compared to the actual path. The text of the wildcard substitutes aligns to the index of the wildcards (from left to right) as defined in your path pattern.
      Parameters:
      aIndexes - The index of the wildcards in question for which to retrieve the substitutes.
      Returns:
      The text substituting the wildcards at the given path pattern's wildcard indexes or null if there is none such substitute.

    • getWildcardReplacement

      String getWildcardReplacement(String aWildcardName)
      Returns the wildcard substitute for the wildcards in your path pattern compared to the actual path. The text of the wildcard substitute aligns to the name of the wildcard (as defined in your path pattern).
      Parameters:
      aWildcardName - The name of the wildcard in question for which to retrieve the substitute.
      Returns:
      The text substituting the wildcard with the given path pattern's wildcard name or null if there is none such substitute.

    • getWildcardReplacements

      String[] getWildcardReplacements(String... aWildcardNames)
      Returns the wildcard substitutes for the wildcards in your path pattern compared to the actual path. The text of the wildcard substitutes aligns to the order of the provided wildcard names (as defined in your path pattern).
      Parameters:
      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 path pattern's wildcard names or null if there are none such substitute.

    • getWildcardNames

      String[] getWildcardNames()
      Retrieves the array of wildcard names (aliases) in this instance.
      Returns:
      The array of wildcard aliases or null if there are none named wildcards.