/*******************************************************************************
 * Copyright (c) 1998, 2008 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the 
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 
 * which accompanies this distribution. 
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at 
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation from Oracle TopLink
 ******************************************************************************/  
package org.eclipse.persistence.annotations;

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

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/** 
 * A TimeOfDay annotation is used to specify a specific time of day using a 
 * Calendar instance which is to be used within an OptimisticLocking annotation.
 * 
 * @see org.eclipse.persistence.annotations.OptimisticLocking
 * @author Guy Pelletier
 * @since Oracle TopLink 11.1.1.0.0 
 */ 
@Target({})
@Retention(RUNTIME)
public @interface TimeOfDay {
    /**
     * (Optional) Hour of the day.
     */ 
    int hour() default 0;

    /**
     * (Optional) Minute of the day.
     */ 
    int minute() default 0;

    /**
     * (Optional) Second of the day.
     */ 
    int second() default 0;

    /**
     * (Optional) Millisecond of the day.
     */ 
    int millisecond() default 0;

    /**
     * Internal use. Do not modify.
     */ 
    boolean specified() default true;
}
