tap

Enum ServiceConnection.LimitUnit

java.lang.Object

java.lang.Enum<ServiceConnection.LimitUnit>

tap.ServiceConnection.LimitUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ServiceConnection.LimitUnit>

Enclosing interface:

ServiceConnection

public static enum ServiceConnection.LimitUnit
extends java.lang.Enum<ServiceConnection.LimitUnit>

List of possible limit units.

Version:

2.3 (04/2019)

Author:

Grégory Mantelet (CDS;ARI)

Enum Constant Summary

Enum Constants

Enum Constant and Description
bytes
gigabytes
kilobytes
megabytes
rows

Method Summary

Modifier and Type	Method and Description
long	bytesFactor() Gets the factor to convert into bytes the value expressed in this unit.
static int	compare(int leftLimit, ServiceConnection.LimitUnit leftUnit, int rightLimit, ServiceConnection.LimitUnit rightUnit) Compares the 2 given values (each one expressed in the given unit).
static int	compare(long x, long y) (Strict copy of Integer.compare(long,long) of Java 1.7)
static int	compare(long leftLimit, ServiceConnection.LimitUnit leftUnit, long rightLimit, ServiceConnection.LimitUnit rightUnit) Compares the 2 given values (each one expressed in the given unit).
boolean	isCompatibleWith(ServiceConnection.LimitUnit anotherUnit) Tells whether the given unit has the same type (bytes or rows).
java.lang.String	toString()
static ServiceConnection.LimitUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ServiceConnection.LimitUnit[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

rows

public static final ServiceConnection.LimitUnit rows

bytes

public static final ServiceConnection.LimitUnit bytes

kilobytes

public static final ServiceConnection.LimitUnit kilobytes

megabytes

public static final ServiceConnection.LimitUnit megabytes

gigabytes

public static final ServiceConnection.LimitUnit gigabytes

Method Detail

values

public static ServiceConnection.LimitUnit[] 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 (ServiceConnection.LimitUnit c : ServiceConnection.LimitUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static ServiceConnection.LimitUnit valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isCompatibleWith

public boolean isCompatibleWith(ServiceConnection.LimitUnit anotherUnit)

Tells whether the given unit has the same type (bytes or rows).

Parameters:

anotherUnit - A unit.

Returns:

true if the given unit has the same type, false otherwise.

Since:

1.1

bytesFactor

public long bytesFactor()

Gets the factor to convert into bytes the value expressed in this unit. Note: if this unit is not a factor of bytes, 1 is returned (so that the factor does not affect the value).

Returns:

The factor need to convert a value expressed in this unit into bytes, or 1 if not a bytes derived unit.

Since:

1.1

compare

public static int compare(int leftLimit,
                          ServiceConnection.LimitUnit leftUnit,
                          int rightLimit,
                          ServiceConnection.LimitUnit rightUnit)
                   throws TAPException

Compares the 2 given values (each one expressed in the given unit).

Conversions are done internally in order to make a correct comparison between the 2 limits.

Parameters:

leftLimit - Value/Limit of the comparison left part.

leftUnit - Unit of the comparison left part value.

rightLimit - Value/Limit of the comparison right part.

rightUnit - Unit of the comparison right part value.

Returns:

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

Throws:

TAPException - If the two given units are not compatible.

Since:

1.1

See Also:

compare(long, tap.ServiceConnection.LimitUnit, long, tap.ServiceConnection.LimitUnit)

compare

public static int compare(long leftLimit,
                          ServiceConnection.LimitUnit leftUnit,
                          long rightLimit,
                          ServiceConnection.LimitUnit rightUnit)
                   throws TAPException

Compares the 2 given values (each one expressed in the given unit).

Conversions are done internally in order to make a correct comparison between the 2 limits.

Parameters:

leftLimit - Value/Limit of the comparison left part.

leftUnit - Unit of the comparison left part value.

rightLimit - Value/Limit of the comparison right part.

rightUnit - Unit of the comparison right part value.

Returns:

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

Throws:

TAPException - If the two given units are not compatible.

Since:

2.3

See Also:

isCompatibleWith(tap.ServiceConnection.LimitUnit), bytesFactor(), Integer.compare(int, int), Long.compare(long, long)

compare

public static int compare(long x,
                          long y)

(Strict copy of Integer.compare(long,long) of Java 1.7)

Compares two long values numerically. The value returned is identical to what would be returned by:

    Long.valueOf(x).compareTo(Long.valueOf(y))
 

Parameters:

x - the first long to compare

y - the second long to compare

Returns:

the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

Since:

1.1

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ServiceConnection.LimitUnit>