Top Description Fields Constructors Methods
com.univocity.parsers.annotations.helpers

public Class TransformedHeader

extends Object
Class Inheritance
Imports
com.univocity.parsers.annotations.*, java.lang.reflect.*

A pair associating a Field of an annotated class to an optional HeaderTransformer obtained from Nested#headerTransformer() when nested classes are used to process beans.
Author
Univocity Software Pty Ltd - [email protected]

Field Summary

Modifier and TypeField and Description
private final Field
private int
private final Method
private final AnnotatedElement
private final HeaderTransformer

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
public int

Returns:

the current header index.
getHeaderIndex
()

Returns the index that determines which column the current field represents, as specified by Parsed#index()

public String

Returns:

the header name to be used for the given field.
getHeaderName
()

Returns the name to be used as a header based on a given field and its Parsed annotation.

public AnnotatedElement

Returns:

the field or method being manipulated by the parser/writer when processing java beans
getTarget
()

Returns the AnnotatedElement used to read/write values from/to.

public String

Returns:

the original attribute name of the field
getTargetName
()

Returns the original attribute name of the field in its containing class.

public boolean

Returns:

a flag indicating whether this is a method that allows reading values only.
isReadOly
()

Returns true if this AnnotatedElement is a Method with no parameters and a return type which can only be used for reading values from the java bean.

public boolean

Returns:

a flag indicating whether this is a method that allows writing values only.
isWriteOnly
()

Returns true if this AnnotatedElement is a Method with parameters and can only be used for writing values into the java bean.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fieldback to summary
private final Field field
indexback to summary
private int index
methodback to summary
private final Method method
targetback to summary
private final AnnotatedElement target
transformerback to summary
private final HeaderTransformer transformer

Constructor Detail

TransformedHeaderback to summary
public TransformedHeader(AnnotatedElement target, HeaderTransformer transformer)

Method Detail

describeback to summary
public String describe()
getHeaderIndexback to summary
public int getHeaderIndex()

Returns the index that determines which column the current field represents, as specified by Parsed#index()

Returns:int

the current header index.

getHeaderNameback to summary
public String getHeaderName()

Returns the name to be used as a header based on a given field and its Parsed annotation.

Returns:String

the header name to be used for the given field.

getTargetback to summary
public AnnotatedElement getTarget()

Returns the AnnotatedElement used to read/write values from/to.

Returns:AnnotatedElement

the field or method being manipulated by the parser/writer when processing java beans

getTargetNameback to summary
public String getTargetName()

Returns the original attribute name of the field in its containing class.

Returns:String

the original attribute name of the field

isReadOlyback to summary
public boolean isReadOly()

Returns true if this AnnotatedElement is a Method with no parameters and a return type which can only be used for reading values from the java bean.

Returns:boolean

a flag indicating whether this is a method that allows reading values only.

isWriteOnlyback to summary
public boolean isWriteOnly()

Returns true if this AnnotatedElement is a Method with parameters and can only be used for writing values into the java bean.

Returns:boolean

a flag indicating whether this is a method that allows writing values only.