Module org.seasar.doma.core
Package org.seasar.doma.internal.jdbc.entity

Record Class PropertyPathSegment.Optional

java.lang.Object
java.lang.Record
org.seasar.doma.internal.jdbc.entity.PropertyPathSegment.Optional
Record Components:
name - the name of the property segment
elementClass - the class of the element wrapped by the Optional
All Implemented Interfaces:
PropertyPathSegment
Enclosing interface:
PropertyPathSegment
public static record PropertyPathSegment.Optional(String name, Class<?> elementClass) extends Record implements PropertyPathSegment
A property path segment implementation for optional field access.

This implementation handles fields of type Optional, providing access to the wrapped value rather than the Optional container itself. When getting values, it unwraps the Optional and returns the contained value (or null if empty). The type returned by the wrapper is the element type rather than Optional.

  • Constructor Details

    • Optional

      public Optional(String name, Class<?> elementClass)
      Creates an instance of a Optional record class.
      Parameters:
      name - the value for the name record component
      elementClass - the value for the elementClass record component

  • Method Details

    • wrapField

      public FieldWrapper wrapField(Field field) throws WrapException
      Creates a field wrapper for optional field access.

      This method creates a wrapper that handles Optional fields by unwrapping their values. The wrapper's get method returns the unwrapped value (or null), and the getType method returns the element type rather than Optional.

      Specified by:
      wrapField in interface PropertyPathSegment
      Parameters:
      field - the Optional field to wrap, must be of type Optional
      Returns:
      a field wrapper that unwraps Optional values
      Throws:
      IllegalArgumentException - if the field is not of type Optional
      WrapException - if an error occurs while creating the wrapper

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface PropertyPathSegment
      Returns:
      the value of the name record component

    • elementClass

      public Class<?> elementClass()
      Returns the value of the elementClass record component.
      Returns:
      the value of the elementClass record component