Package org.eclipse.hono.util

Class ResourceLimitsPeriod

java.lang.Object

org.eclipse.hono.util.ResourceLimitsPeriod

public class ResourceLimitsPeriod
extends Object

The period definition corresponding to a resource limit for a tenant.

Constructor Summary

Constructors

Constructor	Description
ResourceLimitsPeriod()

Method Summary

Modifier and Type	Method	Description
String	getMode()	Gets the mode of period for resource limit calculation.
int	getNoOfDays()	Gets the number of days for which resource usage is calculated.
ResourceLimitsPeriod	setMode(String mode)	Sets the mode of period for resource limit calculation.
ResourceLimitsPeriod	setNoOfDays(int noOfDays)	Sets the number of days for which resource usage is calculated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceLimitsPeriod

public ResourceLimitsPeriod()

Method Detail

getMode

public final String getMode()

Gets the mode of period for resource limit calculation.

Returns:

The mode of period for resource limit calculation.

setMode

public final ResourceLimitsPeriod setMode(String mode)

Sets the mode of period for resource limit calculation.

Parameters:

mode - The mode of period for resource limit calculation.

Returns:

a reference to this for fluent use.

Throws:

NullPointerException - if mode is null.

getNoOfDays

public final int getNoOfDays()

Gets the number of days for which resource usage is calculated.

Returns:

The number of days for a resource limit calculation.

setNoOfDays

public final ResourceLimitsPeriod setNoOfDays(int noOfDays)

Sets the number of days for which resource usage is calculated.

Parameters:

noOfDays - The number of days for which resource usage is calculated.

Returns:

a reference to this for fluent use.

Throws:

IllegalArgumentException - if the number of days is negative.