org.orekit.utils
Enum IntervalEndpointType

java.lang.Object
  java.lang.Enum<IntervalEndpointType>
      org.orekit.utils.IntervalEndpointType

All Implemented Interfaces:

Serializable, Comparable<IntervalEndpointType>

public enum IntervalEndpointType
extends Enum<IntervalEndpointType>

- Describes the type of an interval endpoint : OPENED or CLOSED.

Since:

3.0

Version:

$Id: IntervalEndpointType.java 17602 2017-05-18 08:25:23Z bignon $

Author:

Pierre Cardoso

See Also:

GenericInterval

Use sample :

An interval of Doubles ] 1.0 ; 2.0 [ is created this way :

Interval interval = new Interval(IntervalEndpointType.OPEN, 1.0, 2.0, IntervalEndpointType.OPEN);

Concurrency :

unconditionally thread-safe

Enum Constant Summary

CLOSED
the end point is in the interval.

OPEN
the end point is not in the interval.

Method Summary

IntervalEndpointType	getOpposite() Returns OPEN if the instance is CLOSED and CLOSED if the instance is OPEN.
static IntervalEndpointType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntervalEndpointType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPEN

public static final IntervalEndpointType OPEN

the end point is not in the interval.

CLOSED

public static final IntervalEndpointType CLOSED

the end point is in the interval.

Method Detail

values

public static IntervalEndpointType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IntervalEndpointType c : IntervalEndpointType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IntervalEndpointType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOpposite

public IntervalEndpointType getOpposite()

Returns OPEN if the instance is CLOSED and CLOSED if the instance is OPEN.

Returns:

an IntervalEndpointType