net.named_data.jndn.encrypt

Class Interval

java.lang.Object

net.named_data.jndn.encrypt.Interval

public class Interval
extends Object

An Interval defines a time duration which contains a start timestamp and an end timestamp.

Note:

This class is an experimental feature. The API may change.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Interval.Error Interval.Error extends Exception for errors using Interval methods.

Constructor Summary

Constructors

Constructor and Description
Interval() Create an Interval that is invalid.
Interval(boolean isValid) Create an Interval that is either invalid or an empty interval.
Interval(double startTime, double endTime) Create a valid Interval with the given start and end times.
Interval(Interval interval) Create an Interval, copying values from the other interval.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	covers(double timePoint) Check if the time point is in this interval.
double	getEndTime() Get the end time.
double	getStartTime() Get the start time.
Interval	intersectWith(Interval interval) Set this Interval to the intersection of this and the other interval.
boolean	isEmpty() Check if this Interval is empty.
boolean	isValid() Check if this Interval is valid.
void	set(Interval interval) Set this interval to have the same values as the other interval.
Interval	unionWith(Interval interval) Set this Interval to the union of this and the other interval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Interval

public Interval(boolean isValid)

Create an Interval that is either invalid or an empty interval.

Parameters:

isValid - True to create a valid empty interval, false to create an invalid interval.

Interval

public Interval(double startTime,
        double endTime)

Create a valid Interval with the given start and end times. The start time must be less than the end time. To create an empty interval (start time equals end time), use the constructor Interval(true).

Parameters:

startTime - The start time as milliseconds since Jan 1, 1970 UTC.

endTime - The end time as milliseconds since Jan 1, 1970 UTC.

Interval

public Interval(Interval interval)

Create an Interval, copying values from the other interval.

Parameters:

interval - The other Interval with values to copy

Interval

public Interval()

Create an Interval that is invalid.

Method Detail

set

public void set(Interval interval)

Set this interval to have the same values as the other interval.

Parameters:

interval - The other Interval with values to copy.

covers

public final boolean covers(double timePoint)

Check if the time point is in this interval.

Parameters:

timePoint - The time point to check as milliseconds since Jan 1, 1970 UTC.

Returns:

True if timePoint is in this interval.

intersectWith

public final Interval intersectWith(Interval interval)

Set this Interval to the intersection of this and the other interval. This and the other interval should be valid but either can be empty.

Parameters:

interval - The other Interval to intersect with.

Returns:

This Interval.

unionWith

public final Interval unionWith(Interval interval)
                         throws Interval.Error

Set this Interval to the union of this and the other interval. This and the other interval should be valid but either can be empty. This and the other interval should have an intersection. (Contiguous intervals are not allowed.)

Parameters:

interval - The other Interval to union with.

Returns:

This Interval.

Throws:

Interval.Error - if the two intervals do not have an intersection.

getStartTime

public final double getStartTime()

Get the start time.

Returns:

The start time as milliseconds since Jan 1, 1970 UTC.

getEndTime

public final double getEndTime()

Get the end time.

Returns:

The end time as milliseconds since Jan 1, 1970 UTC.

isValid

public final boolean isValid()

Check if this Interval is valid.

Returns:

True if this interval is valid, false if invalid.

isEmpty

public final boolean isEmpty()

Check if this Interval is empty.

Returns:

True if this Interval is empty (start time equals end time), false if not.