Package com.univocity.parsers.annotations.helpers

Class FieldMapping

java.lang.Object
com.univocity.parsers.annotations.helpers.FieldMapping
public class FieldMapping extends Object
A helper class with information about the location of an field annotated with Parsed in a record.

  • Field Details

    • parentClass

      private final Class parentClass

    • target

      private final AnnotatedElement target

    • index

      private int index

    • fieldName

      private NormalizedString fieldName

    • beanClass

      private final Class<?> beanClass

    • readMethod

      private final Method readMethod

    • writeMethod

      private final Method writeMethod

    • accessible

      private boolean accessible

    • primitive

      private final boolean primitive

    • defaultPrimitiveValue

      private final Object defaultPrimitiveValue

    • applyDefault

      private Boolean applyDefault

    • fieldType

      private Class fieldType

    • primitiveNumber

      private boolean primitiveNumber

  • Constructor Details

  • Method Details

    • determineFieldMapping

      private void determineFieldMapping(HeaderTransformer transformer, NormalizedString[] headers)

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isMappedToIndex

      public boolean isMappedToIndex()
      Returns true if the field is mapped to a column index, otherwise false
      Returns:
      true if the field is mapped to a column index, otherwise false

    • isMappedToField

      public boolean isMappedToField()
      Returns true if the field is mapped to a column name, otherwise false
      Returns:
      true if the field is mapped to a column name, otherwise false

    • getIndex

      public int getIndex()
      Returns the column index against which this field is mapped.
      Returns:
      the column index associated with this field, or -1 if there's no such association.

    • setIndex

      public void setIndex(int index)
      Defines the column index against which this field is mapped, overriding any current position derived from annotations.
      Parameters:
      index - the column index associated with this field

    • setFieldName

      public void setFieldName(String fieldName)
      Defines the column name against which this field is mapped, overriding any current name derived from annotations or from the attribute name itself.
      Parameters:
      fieldName - the column name associated with this field

    • setFieldName

      public void setFieldName(NormalizedString fieldName)
      Defines the column name against which this field is mapped, overriding any current name derived from annotations or from the attribute name itself.
      Parameters:
      fieldName - the column name associated with this field

    • getFieldName

      public NormalizedString getFieldName()
      Returns the column name against which this field is mapped.
      Returns:
      the column name associated with this field, or null if there's no such association.

    • getTarget

      public AnnotatedElement getTarget()
      Returns the Field mapped to a column
      Returns:
      the Field mapped to a column

    • setAccessible

      private void setAccessible()

    • getFieldParent

      public Class<?> getFieldParent()
      Returns the parent class that contains the mapped field.
      Returns:
      the field's parent class

    • getFieldType

      public Class<?> getFieldType()
      Returns the type of the mapped field
      Returns:
      the field type.

    • canWrite

      public boolean canWrite(Object instance)
      Queries whether this field mapping can be applied over a given object instance.
      Parameters:
      instance - the object whose type will be verified in order to identify if it contains the mapped field
      Returns:
      true if the given instance contains the field/accessor method and can use this field mapping to modify its internal state; otherwise false

    • read

      public Object read(Object instance)
      Reads the value accessible by this field mapping from a given object
      Parameters:
      instance - the object whose field, mapped by this field mapping, will be read
      Returns:
      the value contained in the given instance's field

    • read

      private Object read(Object instance, boolean ignoreErrors)

    • write

      public void write(Object instance, Object value)
      Writes a value to the field of a given object instance, whose field is accessible through this field mapping.
      Parameters:
      instance - the object whose field will be set
      value - the value to set on the given object's field.

    • toString

      public String toString()
      Overrides:
      toString in class Object