Index

A B C E F G H I L M O R T W
All Classes and Interfaces|All Packages|Serialized Form

A

addFieldMapping(CSVFieldMapping) - Method in class org.csvobjects.csv.mapping.CSVBeanMapping.Builder

Adds a new field mapping for this bean mapping.

attributeName() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the attributeName record component.

attributeName(String) - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Sets the mapped POJO's attribute name corresponding to this field.

B

beanClass() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns the value of the beanClass record component.

beanClass(String) - Method in class org.csvobjects.csv.mapping.CSVBeanMapping.Builder

Sets the mapped bean's fully qualified class name.

beanName() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns the value of the beanName record component.

beanName(String) - Method in class org.csvobjects.csv.mapping.CSVBeanMapping.Builder

Sets the mapped bean's user defined name.

beanReference() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the beanReference record component.

beanReferenceName() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the beanReferenceName record component.

beanReferenceName(String) - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Sets the declarative name of a referenced bean mapping for this field.

build() - Method in class org.csvobjects.csv.mapping.CSVBeanMapping.Builder

Builds the immutable bean mapping.

build() - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Builds the immutable field mapping.

builder() - Static method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns a new builder for incrementally constructing a bean mapping while its field mappings are being parsed.

builder() - Static method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns a new builder for incrementally constructing a field mapping from its declarative (parse-time) attributes.

C

ClasspathResourceLoader - Class in org.csvobjects.csv

Resolves classpath resources with a consistent loader fallback order.

close() - Method in class org.csvobjects.csv.CSVParser

Closes the parser.

compareTo(FormatterConfiguration) - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Compares this formatter configuration to another configuration for ordering purposes.

compareTo(CSVFieldMapping) - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Compares this field mapping to another mapping.

constructionNeeded() - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Returns the value of the constructionNeeded record component.

createFormatterFor(String) - Method in class org.csvobjects.csv.formatters.CSVFormatterFactory

Creates a new instance of the specified formatter.

CSVBeanMapping - Record Class in org.csvobjects.csv.mapping

Represents the CSV to Java Bean mapping for a single Java bean.

CSVBeanMapping(String, String, boolean, SortedSet<CSVFieldMapping>, int) - Constructor for record class org.csvobjects.csv.mapping.CSVBeanMapping

Compact constructor which normalizes the trimmable string attributes and defensively copies the field mapping set into an unmodifiable snapshot.

CSVBeanMapping.Builder - Class in org.csvobjects.csv.mapping

Mutable builder for incrementally constructing an immutable CSVBeanMapping while its field mappings are being parsed.

CSVBeanMappingTaglet - Class in org.csvobjects.csv.taglets

Taglet for outputting the CSV bean mapping information.

CSVBeanMappingTaglet() - Constructor for class org.csvobjects.csv.taglets.CSVBeanMappingTaglet

CSVFieldFormatter - Interface in org.csvobjects.csv.formatters

Main Interface for a CSV field formatter.

CSVFieldMapping - Record Class in org.csvobjects.csv.mapping

Represents a single CSV field to Java Bean attribute mapping.

CSVFieldMapping(String, String, int, String, CSVFieldFormatter, String, String, CSVBeanMapping) - Constructor for record class org.csvobjects.csv.mapping.CSVFieldMapping

Compact constructor which normalizes the trimmable string attributes.

CSVFieldMapping.Builder - Class in org.csvobjects.csv.mapping

Mutable builder for incrementally constructing an immutable CSVFieldMapping from its declarative (parse-time) attributes.

CSVFieldMappingTaglet - Class in org.csvobjects.csv.taglets

Taglet for outputting the field mapping tag information.

CSVFieldMappingTaglet() - Constructor for class org.csvobjects.csv.taglets.CSVFieldMappingTaglet

CSVFormatterFactory - Class in org.csvobjects.csv.formatters

A singleton factory which creates and caches the csv field formatters.

CSVFormatterMappingTaglet - Class in org.csvobjects.csv.taglets

Taglet for outputting the CSV Formatter tag's name attribute.

CSVFormatterMappingTaglet() - Constructor for class org.csvobjects.csv.taglets.CSVFormatterMappingTaglet

csvHeaderPresent() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns the value of the csvHeaderPresent record component.

csvHeaderPresent(boolean) - Method in class org.csvobjects.csv.mapping.CSVBeanMapping.Builder

Sets the flag which indicates whether a header row is present in the mapped CSV file or stream.

CSVMappingParser - Class in org.csvobjects.csv.mapping

XML Parser to parse and return the mapping configuration.

CSVMappingParser() - Constructor for class org.csvobjects.csv.mapping.CSVMappingParser

CSVOException - Exception Class in org.csvobjects.csv.exceptions

An unchecked exception for the CSV Objects framework, thrown for internal framework failures that are not expected to be recoverable by callers (invalid mapping/formatter configuration, malformed metadata, and similar setup-time errors).

CSVOException() - Constructor for exception class org.csvobjects.csv.exceptions.CSVOException

Default Constructor.

CSVOException(String) - Constructor for exception class org.csvobjects.csv.exceptions.CSVOException

Constructor accepting a message string.

CSVOException(String, Throwable) - Constructor for exception class org.csvobjects.csv.exceptions.CSVOException

Constructor accepting a message and a root cause exception to embed.

CSVOException(Throwable) - Constructor for exception class org.csvobjects.csv.exceptions.CSVOException

Constructor accepting the root cause exception to embed.

CSVParser - Class in org.csvobjects.csv

Parses CSV files and creates the mapped POJO objects.

CSVParser(CSVBeanMapping, CSVReader) - Constructor for class org.csvobjects.csv.CSVParser

Constructor for CSVParser.

CSVParserFactory - Class in org.csvobjects.csv

Singleton factory for creating the CSVParser parser objects for clients of the framework.

E

equals(Object) - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Compares this bean mapping to another for equality.

equals(Object) - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Compares this field mapping with another for equality.

F

fieldMappings() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns the value of the fieldMappings record component.

fieldName() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the fieldName record component.

fieldName(String) - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Sets the user defined name of this field.

fieldPosition() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the fieldPosition record component.

fieldPosition(int) - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Sets this field's position in the CSV line.

fieldType() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the fieldType record component.

fieldType(String) - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Sets the fully qualified Java type name of this field.

format(String) - Method in interface org.csvobjects.csv.formatters.CSVFieldFormatter

Formats the specified CSV field value and returns the formatted result.

formatter() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the formatter record component.

formatterClass() - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Returns the value of the formatterClass record component.

FormatterConfiguration - Record Class in org.csvobjects.csv.formatters

Immutable configuration for a single declaratively named CSV field formatter.

FormatterConfiguration(String, String, boolean) - Constructor for record class org.csvobjects.csv.formatters.FormatterConfiguration

Creates an instance of a FormatterConfiguration record class.

formatterName() - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Returns the value of the formatterName record component.

G

getAllowedLocations() - Method in class org.csvobjects.csv.taglets.CSVBeanMappingTaglet

getAllowedLocations() - Method in class org.csvobjects.csv.taglets.CSVFieldMappingTaglet

getAllowedLocations() - Method in class org.csvobjects.csv.taglets.CSVFormatterMappingTaglet

getBeanMapping(String) - Method in class org.csvobjects.csv.CSVParserFactory

Returns the requested bean mapping configuration.

getCSVParser(String, Reader) - Method in class org.csvobjects.csv.CSVParserFactory

Returns a new CSV file parser for the specified mapping and the specified CSV reader stream.

getCSVParser(String, String, boolean) - Method in class org.csvobjects.csv.CSVParserFactory

Returns a new CSV file parser for the specified mapping, and the specified CSV file.

getMappings(String, boolean) - Method in class org.csvobjects.csv.mapping.CSVMappingParser

Returns the map of parsed mapping configuration beans.

getName() - Method in class org.csvobjects.csv.taglets.CSVBeanMappingTaglet

getName() - Method in class org.csvobjects.csv.taglets.CSVFieldMappingTaglet

getName() - Method in class org.csvobjects.csv.taglets.CSVFormatterMappingTaglet

getRootBeanMapping() - Method in class org.csvobjects.csv.CSVParser

Returns the root bean mapping.

getSingleton() - Static method in class org.csvobjects.csv.CSVParserFactory

Returns the singleton instance of this factory.

getSingleton() - Static method in class org.csvobjects.csv.formatters.CSVFormatterFactory

Returns the singleton instance of this factory.

H

hashCode() - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Returns a hash code value for this object.

hashCode() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns the hash code for this bean mapping.

hashCode() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the hash code for this field mapping.

I

isInlineTag() - Method in class org.csvobjects.csv.taglets.CSVBeanMappingTaglet

isInlineTag() - Method in class org.csvobjects.csv.taglets.CSVFieldMappingTaglet

isInlineTag() - Method in class org.csvobjects.csv.taglets.CSVFormatterMappingTaglet

iterator() - Method in class org.csvobjects.csv.CSVParser

Returns the iterator for retrieving the parsed POJO beans.

iterator() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Provides an iterator over the CSV field mappings present in this bean mapping.

L

LOG - Static variable in class org.csvobjects.csv.CSVParser

The logger to use.

M

maxFieldPosition() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns the value of the maxFieldPosition record component.

O

open(String, Class<?>) - Static method in class org.csvobjects.csv.ClasspathResourceLoader

Open a classpath resource using context loader, then anchor loader, then system loader.

org.csvobjects.csv - package org.csvobjects.csv

Provides the core CSV parsing and mapping framework.

org.csvobjects.csv.exceptions - package org.csvobjects.csv.exceptions

org.csvobjects.csv.formatters - package org.csvobjects.csv.formatters

Provides CSV field formatter interfaces and default implementations.

org.csvobjects.csv.mapping - package org.csvobjects.csv.mapping

Internal mapping model and XML parser components for CSV-to-POJO mappings.

org.csvobjects.csv.taglets - package org.csvobjects.csv.taglets

Custom Javadoc taglets for rendering @csv.* mapping annotations in generated API documentation.

R

reformatterName() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns the value of the reformatterName record component.

reformatterName(String) - Method in class org.csvobjects.csv.mapping.CSVFieldMapping.Builder

Sets the declarative name of the formatter attached to this field.

T

toString() - Method in class org.csvobjects.csv.CSVParser

Dumps the root bean mapping configuration for this parser.

toString() - Method in record class org.csvobjects.csv.formatters.FormatterConfiguration

Returns a string representation of this record class.

toString() - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Dumps content of the bean mapping.

toString() - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Dumps the contents of this field mapping as a string.

toString(List<? extends DocTree>, Element) - Method in class org.csvobjects.csv.taglets.CSVBeanMappingTaglet

toString(List<? extends DocTree>, Element) - Method in class org.csvobjects.csv.taglets.CSVFieldMappingTaglet

toString(List<? extends DocTree>, Element) - Method in class org.csvobjects.csv.taglets.CSVFormatterMappingTaglet

W

withBeanReference(CSVBeanMapping) - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns a copy of this field mapping with the resolved bean reference set.

withBeanReferenceName(String) - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns a copy of this field mapping with the declarative bean reference name replaced (for example, reset to "none" when the referenced bean cannot be resolved).

withFieldMappings(Collection<CSVFieldMapping>) - Method in record class org.csvobjects.csv.mapping.CSVBeanMapping

Returns a copy of this bean mapping with its field mappings replaced, for example once formatters and bean references have been resolved for each field.

withFormatter(CSVFieldFormatter) - Method in record class org.csvobjects.csv.mapping.CSVFieldMapping

Returns a copy of this field mapping with the resolved formatter set.

A B C E F G H I L M O R T W
All Classes and Interfaces|All Packages|Serialized Form