Package org.apache.hadoop.hbase.quotas

Class SpaceQuotaSnapshot.SpaceQuotaStatus

java.lang.Object

org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshot.SpaceQuotaStatus

All Implemented Interfaces:

SpaceQuotaSnapshotView.SpaceQuotaStatusView

Enclosing class:

SpaceQuotaSnapshot

@Private
public static class SpaceQuotaSnapshot.SpaceQuotaStatus
extends Object
implements SpaceQuotaSnapshotView.SpaceQuotaStatusView

Encapsulates the state of a quota on a table. The quota may or may not be in violation. If the quota is not in violation, the violation may be null. If the quota is in violation, there is guaranteed to be a non-null violation policy.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final boolean	inViolation
private static final SpaceQuotaSnapshot.SpaceQuotaStatus	NOT_IN_VIOLATION
(package private) final Optional<SpaceViolationPolicy>	policy

Constructor Summary

Constructors

Modifier	Constructor	Description
	SpaceQuotaStatus(SpaceViolationPolicy policy)	Constructs a SpaceQuotaSnapshot which is in violation of the provided policy.
private	SpaceQuotaStatus(SpaceViolationPolicy policy, boolean inViolation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<SpaceViolationPolicy>	getPolicy()	Returns the violation policy, which may be null.
int	hashCode()
boolean	isInViolation()	Returns true if the quota is being violated, false otherwise.
static SpaceQuotaSnapshot.SpaceQuotaStatus	notInViolation()	Returns a singleton referring to a quota which is not in violation.
static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuotaStatus	toProto(SpaceQuotaSnapshot.SpaceQuotaStatus status)
static SpaceQuotaSnapshot.SpaceQuotaStatus	toStatus(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuotaStatus proto)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NOT_IN_VIOLATION

private static final SpaceQuotaSnapshot.SpaceQuotaStatus NOT_IN_VIOLATION

policy

final Optional<SpaceViolationPolicy> policy

inViolation

final boolean inViolation

Constructor Details

SpaceQuotaStatus

public SpaceQuotaStatus(SpaceViolationPolicy policy)

Constructs a SpaceQuotaSnapshot which is in violation of the provided policy.

Use notInViolation() to obtain an instance of this class for the cases when the quota is not in violation.

Parameters:

policy - The non-null policy being violated.

SpaceQuotaStatus

private SpaceQuotaStatus(SpaceViolationPolicy policy,
 boolean inViolation)

Method Details

getPolicy

public Optional<SpaceViolationPolicy> getPolicy()

Returns the violation policy, which may be null. It is guaranteed to be non-null if isInViolation() is true, but may be null otherwise.

Specified by:

getPolicy in interface SpaceQuotaSnapshotView.SpaceQuotaStatusView

isInViolation

public boolean isInViolation()

Returns true if the quota is being violated, false otherwise.

Specified by:

isInViolation in interface SpaceQuotaSnapshotView.SpaceQuotaStatusView

notInViolation

public static SpaceQuotaSnapshot.SpaceQuotaStatus notInViolation()

Returns a singleton referring to a quota which is not in violation.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toProto

public static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuotaStatus toProto(SpaceQuotaSnapshot.SpaceQuotaStatus status)

toStatus

public static SpaceQuotaSnapshot.SpaceQuotaStatus toStatus(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuotaStatus proto)