/*
* Copyright 2017 Andrew Rucker Jones.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.opencsv.bean;
Represents one entry in FieldMapByName
. Note: This is not used in the internal structure of FieldMapByName
, but rather when representing its contents to the outside world. Author: Andrew Rucker Jones Type parameters: - <T> – The type of the bean being converted
Since: 4.2
/**
* Represents one entry in {@link FieldMapByName}.
* Note: This is not used in the internal structure of {@link FieldMapByName}, but
* rather when representing its contents to the outside world.
* @param <T> The type of the bean being converted
*
* @author Andrew Rucker Jones
* @since 4.2
*/
public class FieldMapByNameEntry<T> {
The name of the header or a regular expression pattern matching possible
names for the header.
/**
* The name of the header or a regular expression pattern matching possible
* names for the header.
*/
private final String name;
The BeanField
associated with this header or these headers. /** The {@link BeanField} associated with this header or these headers. */
private final BeanField<T, String> field;
Whether FieldMapByNameEntry<T>.name
is a header name or a regular expression pattern that is meant to match header names. /**
* Whether {@link #name} is a header name or a regular expression pattern
* that is meant to match header names.
*/
private final boolean regexPattern;
Initializes the entry.
Params: - name – The name or regular expression pattern representing the header(s)
- field – The field associated with the header(s)
- regexPattern – Whether or not
name
is a regular expression pattern
/**
* Initializes the entry.
*
* @param name The name or regular expression pattern representing the header(s)
* @param field The field associated with the header(s)
* @param regexPattern Whether or not {@code name} is a regular expression pattern
*/
public FieldMapByNameEntry(String name, BeanField<T, String> field, boolean regexPattern) {
this.name = name;
this.field = field;
this.regexPattern = regexPattern;
}
Returns: The name of the header or a regular expression pattern
matching all possible header names
/**
* @return The name of the header or a regular expression pattern
* matching all possible header names
*/
public String getName() {
return name;
}
Returns: The BeanField
associated with this header or these headers
/**
* @return The {@link BeanField} associated with this header or these headers
*/
public BeanField<T, String> getField() {
return field;
}
Returns: Whether the string returned by getName()
is a header name or a regular expression pattern to match header names
/**
* @return Whether the string returned by {@link #getName()} is a header name
* or a regular expression pattern to match header names
*/
public boolean isRegexPattern() {
return regexPattern;
}
}