Package org.orekit.utils

Enum Class ExpungePolicy

java.lang.Object

java.lang.Enum<ExpungePolicy>

org.orekit.utils.ExpungePolicy

All Implemented Interfaces:

Serializable, Comparable<ExpungePolicy>, Constable

public enum ExpungePolicy
extends Enum<ExpungePolicy>

Expunge policy to apply when a TimeSpanMap exceeds its capacity.

Since:

13.1

Author:

Luc Maisonobe

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPUNGE_EARLIEST	Expunge the span before the first transition.
EXPUNGE_FARTHEST	Expunge either the earliest or latest span, depending on which is farthest from the last added transition.
EXPUNGE_LATEST	Expunge the span after the latest transition.

Method Summary

Modifier and Type	Method	Description
static ExpungePolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ExpungePolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXPUNGE_EARLIEST

public static final ExpungePolicy EXPUNGE_EARLIEST

Expunge the span before the first transition.

Note that if we add data to the map in reverse chronological order, then entries exceeding capacity are expunged as soon as we attempt to add them, so this policy should probably not be used in reverse chronological order.

EXPUNGE_LATEST

public static final ExpungePolicy EXPUNGE_LATEST

Expunge the span after the latest transition.

Note that if we add data to the map in chronological order, then entries exceeding capacity are expunged as soon as we attempt to add them, so this policy should probably not be used in chronological order.

EXPUNGE_FARTHEST

public static final ExpungePolicy EXPUNGE_FARTHEST

Expunge either the earliest or latest span, depending on which is farthest from the last added transition.

Method Details

values

public static ExpungePolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ExpungePolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null