LimitArg (Gemma 1.31.4 API)

java.lang.Object
- ubic.gemma.rest.util.args.AbstractArg<Integer>
- - ubic.gemma.rest.util.args.LimitArg

All Implemented Interfaces:

Arg<Integer>
```
public class LimitArg
extends AbstractArg<Integer>
```
Argument used to represent a limit.

Field Summary

Fields
Modifier and Type Field Description

static int MAXIMUM
This is the default maximum used for getValue().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`getValue()`	Obtain the value of the limit ensuring that it is smaller than `MAXIMUM`
`Integer`	`getValue(Integer maximum)`	Obtain the value of the limit and ensure it is smaller than a given maximum.
`Integer`	`getValueNoMaximum()`	Obtain the value of the limit, explicitly disregarding the maximum defined by `MAXIMUM`.
`static LimitArg`	`valueOf(String s)`

Methods inherited from class ubic.gemma.rest.util.args.AbstractArg
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAXIMUM
```
public static int MAXIMUM
```
    This is the default maximum used for getValue().
- Method Detail
  - getValue
```
@Nonnull
public Integer getValue()
```
    Obtain the value of the limit ensuring that it is smaller than MAXIMUM
    
    Specified by:
    
    getValue in interface Arg<Integer>
    
    Overrides:
    
    getValue in class AbstractArg<Integer>
    
    Returns:
    
    the value represented by this argument, which can never be null
  - getValue
```
public Integer getValue(Integer maximum)
                 throws MalformedArgException
```
    Obtain the value of the limit and ensure it is smaller than a given maximum. Use getValue() to accept any limit.
    
    Parameters:
    
    maximum - a maximum the limit must not exceeed, otherwise a MalformedArgException will be raised
    
    Throws:
    
    MalformedArgException - of the limit is exceeded, or the argument was malformed in the first place.
  - getValueNoMaximum
```
public Integer getValueNoMaximum()
```
    Obtain the value of the limit, explicitly disregarding the maximum defined by MAXIMUM.
  - valueOf
```
public static LimitArg valueOf(String s)
                        throws MalformedArgException
```
    Throws:
    
    MalformedArgException