format.bind.annotation.FormatFieldConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jformatb-api Show documentation

Turn formatted text to java bean and vice versa

There is a newer version: 0.4

/*
 * Copyright 2024 jFormat-B
 *
 * 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 format.bind.annotation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import format.bind.converter.FieldConverter;

/**
 * Specifies a converter that implements {@link FieldConverter} for custom conversion.
 * 
 * Usage
 * 
 * The {@code FormatFieldConverter} annotation can be used with the following program elements:
 * 
 * 
 * a JavaBean property
 * non static and non transient field
 * from within {@link FormatFieldConverters}
 * 
 * 
 * @author Yannick Ebongue
 * 
 */
@Repeatable(FormatFieldConverters.class)
@Documented
@Retention(RUNTIME)
@Target({ TYPE, FIELD, METHOD })
public @interface FormatFieldConverter {

	/**
	 * (Optional) The {@code property} must be specified if this annotation is used at
	 * class level. Otherwise the {@code property} must not be specified.
	 * 
	 * @return The property name of the text field converter.
	 */
	String property() default "";

	/**
	 * (Required) The class that converts a text format field value to a bound type
	 * or vice versa.
	 * 
	 * 
	 * See {@link FieldConverter} for more details.
	 * 
	 * 
	 * @return The class that converts a text format field.
	 */
	@SuppressWarnings("rawtypes")
	Class value();

}