Record Class BeanSerdeShape.BeanProperty

java.lang.Object
java.lang.Record
io.micronaut.serde.processor.sourcegen.beans.BeanSerdeShape.BeanProperty
Record Components:
name - Property name.
serializationType - Property type used for serialization.
deserializationType - Property type used for deserialization.
nonNull - Whether the property is non-null.
nullable - Whether the property is nullable.
keyMetadata - Pre-resolved metadata contributed with the property key.
include - The inclusion resolved at build time, or null when the configuration decides.
required - Whether the property has to be present and non-null in the input.
aliases - Additional names the property is read from.
readMethod - Bean getter method.
writeMethod - Bean setter method.
readField - Bean field used for reading.
writeField - Bean field used for writing.
Enclosing class:
BeanSerdeShape
public static record BeanSerdeShape.BeanProperty(String name, io.micronaut.inject.ast.ClassElement serializationType, io.micronaut.inject.ast.ClassElement deserializationType, boolean nonNull, boolean nullable, Map<String,String> keyMetadata, @Nullable SerdeConfig.SerInclude include, boolean required, List<String> aliases, @Nullable io.micronaut.inject.ast.MethodElement readMethod, @Nullable io.micronaut.inject.ast.MethodElement writeMethod, @Nullable io.micronaut.inject.ast.FieldElement readField, @Nullable io.micronaut.inject.ast.FieldElement writeField) extends Record
Bean property metadata used by source generation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BeanProperty(String name, io.micronaut.inject.ast.ClassElement serializationType, io.micronaut.inject.ast.ClassElement deserializationType, boolean nonNull, boolean nullable, @Nullable io.micronaut.inject.ast.MethodElement readMethod, @Nullable io.micronaut.inject.ast.MethodElement writeMethod, @Nullable io.micronaut.inject.ast.FieldElement readField, @Nullable io.micronaut.inject.ast.FieldElement writeField)
    Creates a property without contributed key metadata.
    BeanProperty(String name, io.micronaut.inject.ast.ClassElement serializationType, io.micronaut.inject.ast.ClassElement deserializationType, boolean nonNull, boolean nullable, Map<String,String> keyMetadata, @Nullable SerdeConfig.SerInclude include, boolean required, List<String> aliases, @Nullable io.micronaut.inject.ast.MethodElement readMethod, @Nullable io.micronaut.inject.ast.MethodElement writeMethod, @Nullable io.micronaut.inject.ast.FieldElement readField, @Nullable io.micronaut.inject.ast.FieldElement writeField)
    Creates an instance of a BeanProperty record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    aliases()
    Returns the value of the aliases record component.
    io.micronaut.inject.ast.ClassElement
    deserializationType()
    Returns the value of the deserializationType record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable SerdeConfig.SerInclude
    include()
    Returns the value of the include record component.
    Map<String,String>
    keyMetadata()
    Returns the value of the keyMetadata record component.
    String
    name()
    Returns the value of the name record component.
    boolean
    nonNull()
    Returns the value of the nonNull record component.
    boolean
    nullable()
    Returns the value of the nullable record component.
    @Nullable io.micronaut.inject.ast.FieldElement
    readField()
    Returns the value of the readField record component.
    @Nullable io.micronaut.inject.ast.MethodElement
    readMethod()
    Returns the value of the readMethod record component.
    boolean
    required()
    Returns the value of the required record component.
    io.micronaut.inject.ast.ClassElement
    serializationType()
    Returns the value of the serializationType record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable io.micronaut.inject.ast.FieldElement
    writeField()
    Returns the value of the writeField record component.
    @Nullable io.micronaut.inject.ast.MethodElement
    writeMethod()
    Returns the value of the writeMethod record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BeanProperty

      public BeanProperty(String name, io.micronaut.inject.ast.ClassElement serializationType, io.micronaut.inject.ast.ClassElement deserializationType, boolean nonNull, boolean nullable, @Nullable io.micronaut.inject.ast.MethodElement readMethod, @Nullable io.micronaut.inject.ast.MethodElement writeMethod, @Nullable io.micronaut.inject.ast.FieldElement readField, @Nullable io.micronaut.inject.ast.FieldElement writeField)
      Creates a property without contributed key metadata.
      Parameters:
      name - Property name.
      serializationType - Property type used for serialization.
      deserializationType - Property type used for deserialization.
      nonNull - Whether the property is non-null.
      nullable - Whether the property is nullable.
      readMethod - Bean getter method.
      writeMethod - Bean setter method.
      readField - Bean field used for reading.
      writeField - Bean field used for writing.

    • BeanProperty

      public BeanProperty(String name, io.micronaut.inject.ast.ClassElement serializationType, io.micronaut.inject.ast.ClassElement deserializationType, boolean nonNull, boolean nullable, Map<String,String> keyMetadata, @Nullable SerdeConfig.SerInclude include, boolean required, List<String> aliases, @Nullable io.micronaut.inject.ast.MethodElement readMethod, @Nullable io.micronaut.inject.ast.MethodElement writeMethod, @Nullable io.micronaut.inject.ast.FieldElement readField, @Nullable io.micronaut.inject.ast.FieldElement writeField)
      Creates an instance of a BeanProperty record class.
      Parameters:
      name - the value for the name record component
      serializationType - the value for the serializationType record component
      deserializationType - the value for the deserializationType record component
      nonNull - the value for the nonNull record component
      nullable - the value for the nullable record component
      keyMetadata - the value for the keyMetadata record component
      include - the value for the include record component
      required - the value for the required record component
      aliases - the value for the aliases record component
      readMethod - the value for the readMethod record component
      writeMethod - the value for the writeMethod record component
      readField - the value for the readField record component
      writeField - the value for the writeField record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
      Returns:
      the value of the name record component

    • serializationType

      public io.micronaut.inject.ast.ClassElement serializationType()
      Returns the value of the serializationType record component.
      Returns:
      the value of the serializationType record component

    • deserializationType

      public io.micronaut.inject.ast.ClassElement deserializationType()
      Returns the value of the deserializationType record component.
      Returns:
      the value of the deserializationType record component

    • nonNull

      public boolean nonNull()
      Returns the value of the nonNull record component.
      Returns:
      the value of the nonNull record component

    • nullable

      public boolean nullable()
      Returns the value of the nullable record component.
      Returns:
      the value of the nullable record component

    • keyMetadata

      public Map<String,String> keyMetadata()
      Returns the value of the keyMetadata record component.
      Returns:
      the value of the keyMetadata record component

    • include

      public @Nullable SerdeConfig.SerInclude include()
      Returns the value of the include record component.
      Returns:
      the value of the include record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • aliases

      public List<String> aliases()
      Returns the value of the aliases record component.
      Returns:
      the value of the aliases record component

    • readMethod

      public @Nullable io.micronaut.inject.ast.MethodElement readMethod()
      Returns the value of the readMethod record component.
      Returns:
      the value of the readMethod record component

    • writeMethod

      public @Nullable io.micronaut.inject.ast.MethodElement writeMethod()
      Returns the value of the writeMethod record component.
      Returns:
      the value of the writeMethod record component

    • readField

      public @Nullable io.micronaut.inject.ast.FieldElement readField()
      Returns the value of the readField record component.
      Returns:
      the value of the readField record component

    • writeField

      public @Nullable io.micronaut.inject.ast.FieldElement writeField()
      Returns the value of the writeField record component.
      Returns:
      the value of the writeField record component