Package com.atlassian.confluence.api.model

Class Expansions

java.lang.Object
com.atlassian.confluence.api.model.Expansions
public class Expansions extends Object

  • Field Details

  • Constructor Details

  • Method Details

    • of

      public static Expansions of(String... expansionStr)

    • merge

      public Expansions merge(Expansions expansions)

    • merge

      public Expansion[] merge(Expansion[] expansions)

    • canExpand

      public boolean canExpand(String propertyName)

    • getSubExpansions

      public Expansions getSubExpansions(String propertyName)

    • prepend

      public Expansions prepend(String propertyName)
      Create a new Expansions that prepends the propertyName to the path of all expansions represented in this Expansions object.

      The new set of expansions will answer true to canExpand(propertyName) and getSubExpansions(propertyName) will return the original set of expansions.

      Parameters:
      propertyName - - the propertyName to prepend to the set of expansions
      Returns:
      a new set of expansions with the propertyName at the root of the expansions.

    • toArray

      public Expansion[] toArray()

    • isEmpty

      public boolean isEmpty()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • checkRecursiveExpansion

      public void checkRecursiveExpansion(String expansion)
      Checks to see if the passed in expansion string is expanded again somewhere in the expansions map. This check is used to prevent recursive expansions.
      Parameters:
      expansion -

    • encode

      public static String encode(String expand)
      Encode expand string to a format that conforms
      invalid reference 
      com.atlassian.plugins.rest.common.expand.parameter.DefaultExpandParameter.ExpandKey
      Replace colon to __ and everything except colon, underscore and a-zA-Z0-9 to _ for expand key Remove everything except 0-9, :, -, | for indexes
      Parameters:
      expand - single expand string that needs to encode
      Returns:
      encoded expand string

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object