format.bind.annotation.FormatFieldOverride 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;

/**
 * Used to override text format fields mapped on a superclass or JavaBean properties
 * annotated with {@link FormatFieldContainer}.
 * 
 * @author Yannick Ebongue
 * 
 * @see FormatFieldContainer
 * @see FormatSubTypes
 * @see FormatTypeInfo
 * 
 */
@Documented
@Repeatable(FormatFieldOverrides.class)
@Retention(RUNTIME)
@Target({ TYPE, FIELD, METHOD })
public @interface FormatFieldOverride {

	/**
	 * (Required) The name of the property whose mapping is being overridden.
	 * 
	 * @return The name of the property whose mapping is being overridden.
	 */
	String property();

	/**
	 * (Required) The {@link FormatField} annotation with specification to apply.
	 * 
	 * @return The {@link FormatField} annotation with specification to apply.
	 */
	FormatField field();

}