001/*
002 * Copyright 2020 Global Biodiversity Information Facility (GBIF)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.gbif.api.annotation;
017
018import java.lang.annotation.ElementType;
019import java.lang.annotation.Inherited;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Indicates that the field is suitable for String trimming. To use this annotate the method with
026 * Trim AND the fields intended for trimming. The field must be:
027 *
028 * <ul>
029 *   <li>A mutable POJO with getters and setters
030 * </ul>
031 */
032@Retention(RetentionPolicy.RUNTIME)
033@Target({ElementType.PARAMETER, ElementType.METHOD})
034@Inherited
035public @interface Trim {
036
037  /** Flag to indicate the removal of control characters. */
038  boolean removeControlChars() default false;
039}