com.thesett.aima.attribute.time.TimeOfDay Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aima Show documentation

Library of code developed from 'Artificial Intelligence a Modern Approach', Prentice Hall.

There is a newer version: 0.8.3

/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * 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 com.thesett.aima.attribute.time;

/**
 * TimeOfDay represents a time of the day, in hours, minutes, seconds and milliseconds. The 24 hour clock is always used
 * to report the hours component.
 *
 * 
 * CRC Card Responsibilities
 * 
 Provide a mutable time in 24 hour format, down to millisecond accuracy.
 * 
 *
 * @author Rupert Smith
 */
public interface TimeOfDay
{
    /**
     * Provides the hours component. Hours are numbered 0 to 23.
     *
     * @return The hours component.
     */
    public int getHours();

    /**
     * Accepts the hours component.
     *
     * @param hours The hours component. Hours are numbered 0 to 23.
     */
    public void setHours(int hours);

    /**
     * Provides the minutes component. Minutes are numbered 0 to 59.
     *
     * @return The minutes component.
     */
    public int getMinutes();

    /**
     * Accepts the minutes component.
     *
     * @param minutes The minutes component. Minutes are numbered 0 to 59.
     */
    public void setMinutes(int minutes);

    /**
     * Provides the seconds component. Seconds are numbered 0 to 61 (60 and 61 may be used for leap seconds).
     *
     * @return The seconds component.
     */
    public int getSeconds();

    /**
     * Accepts the seconds component.
     *
     * @param seconds The seconds component. Seconds are numbered 0 to 61 (60 and 61 may be used for leap seconds).
     */
    public void setSeconds(int seconds);

    /**
     * Provides the milliseconds component. Milliseconds are numbered 0 to 999.
     *
     * @return The milliseconds component.
     */
    public int getMilliseconds();

    /**
     * Accepts the milliseconds component.
     *
     * @param milliseconds The milliseconds component. Milliseconds are numbered 0 to 999.
     */
    public void setMilliseconds(int milliseconds);
}