Package org.springframework.data.mapping

Class Parameter<T,P extends PersistentProperty<P>>

java.lang.Object
org.springframework.data.mapping.Parameter<T,P>
Type Parameters:
T - the type of the parameter
public class Parameter<T,P extends PersistentProperty<P>> extends Object
Value object to represent constructor parameters.
Author:
Oliver Gierke, Christoph Strobl, Chris Bono

  • Constructor Details

    • Parameter

      public Parameter(@Nullable String name, TypeInformation<T> type, Annotation[] annotations, @Nullable PersistentEntity<T,P> entity)
      Creates a new Parameter with the given name, TypeInformation as well as an array of Annotations. Will inspect the annotations for an Value annotation to lookup a key or an SpEL expression to be evaluated.
      Parameters:
      name - the name of the parameter, can be null
      type - must not be null
      annotations - must not be null but can be empty
      entity - must not be null.

  • Method Details

    • getName

      public @Nullable String getName()
      Returns the name of the parameter (through constructor/method parameter naming).
      Returns:
      the name of the parameter.
      See Also:

    • hasName

      public boolean hasName()
      Returns whether the parameter has a name.
      Returns:
      whether the parameter has a name.
      Since:
      3.5

    • getRequiredName

      public String getRequiredName()
      Returns the required name of the parameter (through constructor/method parameter naming) or throws IllegalStateException if the parameter has no name.
      Returns:
      the parameter name or throws IllegalStateException if the parameter does not have a name.
      Since:
      3.5
      See Also:

    • getType

      public TypeInformation<T> getType()
      Returns the TypeInformation of the parameter.
      Returns:

    • getAnnotations

      public MergedAnnotations getAnnotations()
      Merged annotations that this parameter is annotated with.
      Returns:
      Since:
      2.5

    • getRawType

      public Class<T> getRawType()
      Returns the raw resolved type of the parameter.
      Returns:

    • getSpelExpression

      public @Nullable String getSpelExpression()
      Returns the expression to be used when looking up a source data structure to populate the actual parameter value.
      Returns:
      the expression to be used when looking up a source data structure.

    • getValueExpression

      public @Nullable String getValueExpression()
      Returns the expression to be used when looking up a source data structure to populate the actual parameter value.
      Returns:
      the expression to be used when looking up a source data structure.
      Since:
      3.3

    • getRequiredValueExpression

      public String getRequiredValueExpression()
      Returns the required expression to be used when looking up a source data structure to populate the actual parameter value or throws IllegalStateException if there's no expression.
      Returns:
      the expression to be used when looking up a source data structure.
      Since:
      3.3

    • hasValueExpression

      public boolean hasValueExpression()
      Returns whether the constructor parameter is equipped with a value expression.
      Returns:
      true} if the parameter is equipped with a value expression.
      Since:
      3.3

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object