1 package com.opencsv.bean;
2
3 import org.apache.commons.collections4.MultiValuedMap;
4
5 import java.lang.annotation.*;
6
7 /**
8 * Instructs opencsv to ignore a field and any annotations present.
9 * <p>It is for the <em>mapping strategy</em> in use as if the field were
10 * simply not a part of the bean class. This affects only the functioning of
11 * the mapping strategy, but not the <em>selection</em> of the mapping strategy
12 * if this is done automatically by opencsv.</p>
13 *
14 * @author Andrew Rucker Jones
15 * @since 5.0
16 * @see MappingStrategy#ignoreFields(MultiValuedMap)
17 */
18 @Documented
19 @Retention(RetentionPolicy.RUNTIME)
20 @Target(ElementType.FIELD)
21 public @interface CsvIgnore {
22
23 /**
24 * The names of the profiles for which this field should be ignored.
25 * <p>If the field should be ignored for only some profiles, but not all,
26 * list the profiles that should ignore the field here.</p>
27 * <p>The default value is an empty string, which means all profiles.</p>
28 *
29 * @return The profiles for which this field should be ignored
30 * @since 5.4
31 */
32 String[] profiles() default "";
33 }