com.univocity.parsers.annotations.BooleanString Maven / Gradle / Ivy
Show all versions of univocity-parsers Show documentation
/*******************************************************************************
* Copyright 2014 Univocity Software Pty Ltd
*
* 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.univocity.parsers.annotations;
import com.univocity.parsers.common.processor.*;
import com.univocity.parsers.conversions.*;
import java.lang.annotation.*;
/**
* Indicates that parsed values such as "y", "No" or "null" should be interpreted as boolean values.
* If a parsed value exists in {@link BooleanString#trueStrings()}, then the field will receive true.
* If a parsed value exists in {@link BooleanString#falseStrings()} then the field will receive false.
* A {@link BooleanConversion} will be assigned to this field
*
Commonly used for java beans processed using {@link BeanProcessor} and/or {@link BeanWriterProcessor}
*
* @author Univocity Software Pty Ltd - [email protected]
* @see Conversion
* @see Conversions
* @see BeanProcessor
* @see BeanWriterProcessor
*/
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
public @interface BooleanString {
/**
* A set of Strings that represent the boolean value {@code true} (e.g. "y", "yes", "1")
*
* @return Strings that represent {@code true}
*/
String[] trueStrings();
/**
* A set of Strings that represent the boolean value {@code false} (e.g. "n", "no", "0")
*
* @return Strings that represent {@code false}
*/
String[] falseStrings();
}