Package com.atlassian.servicedesk.api.util.expansion

Class Expansion

java.lang.Object
com.atlassian.servicedesk.api.util.expansion.Expansion
@PublicApi public class Expansion extends Object
Represents a property on a model object and the sub-properties of that property that should be filled in by the service when returning the model object. This allows the service to only provide as much information in the model as required by the requester.

Use the ExpansionsParser to produce expansions from dot delimited strings.

  • Constructor Details

    • Expansion

      public Expansion(String propertyName)

    • Expansion

      public Expansion(String propertyName, Expansions subExpansions)

  • Method Details

    • getPropertyName

      public String getPropertyName()
      Returns:
      the property name of an expansion

    • getSubExpansions

      public Expansions getSubExpansions()
      Returns:
      the sub expansions as an expansion collection

    • combine

      public static Expansion combine(Object... expansionParts)
      Creates an Expansion made up of the given parts. e.g calling combine("a", "b", "c") will return an Expansion for "a.b.c"

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object