Time.java

Go to the documentation of this file.

/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Inc.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * 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 org.omg.dds.core;

import java.io.Serializable;
import java.util.concurrent.TimeUnit;

import org.omg.dds.type.Extensibility;
import org.omg.dds.type.Nested;


@Extensibility(Extensibility.Kind.FINAL_EXTENSIBILITY)
@Nested
public abstract class Time
implements Comparable<Time>, Serializable, DDSObject
{
    // -----------------------------------------------------------------------
    // Private Constants
    // -----------------------------------------------------------------------

    private static final long serialVersionUID = -132361141453190372L;



    // -----------------------------------------------------------------------
    // Factory Methods
    // -----------------------------------------------------------------------

    public static ModifiableTime newTime(
            long time,
            TimeUnit units,
            ServiceEnvironment env)
    {
        if (env == null) {
            throw new IllegalArgumentException(
                    "Invalid ServiceEnvironment (null) provided.");
        }
        return env.getSPI().newTime(time, units);
    }


    public static Time invalidTime(ServiceEnvironment env)
    {
        if (env == null) {
            throw new IllegalArgumentException(
                    "Invalid ServiceEnvironment (null) provided.");
        }
        return env.getSPI().invalidTime();
    }



    // -----------------------------------------------------------------------
    // Instance Methods
    // -----------------------------------------------------------------------

    // --- Data access: ------------------------------------------------------

    public abstract long getTime(TimeUnit inThisUnit);

    public abstract long getRemainder(
            TimeUnit primaryUnit, TimeUnit remainderUnit);


    // --- Query: ------------------------------------------------------------

    public abstract boolean isValid();


    // --- Modification: -----------------------------------------------------

    public abstract ModifiableTime modifiableCopy();
}