/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.search.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Defines the temporal resolution and encoding type of a {@code Calendar} field.
 *
 * <p>
 * <b>Note:</b> Dates are encoded in the GMT/UTC time zone.
 * </p>
 *
 * @author Amin Mohammed-Coleman
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
@Documented
public @interface CalendarBridge {
	/**
	 * @return the resolution for the annotated {@code Calendar} instance. The date of the calendar will be rounded to the specified resolution.
	 */
	Resolution resolution();

	/**
	 * @return the encoding type for the annotated {@code Calendar} instance.
	 */
	EncodingType encoding() default EncodingType.NUMERIC;
}