org.openstreetmap.josm.tools

Class CheckParameterUtil

java.lang.Object

org.openstreetmap.josm.tools.CheckParameterUtil

public final class CheckParameterUtil
extends java.lang.Object

This utility class provides a collection of static helper methods for checking parameters at run-time.

Since:

2711

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CheckParameterUtil()

Method Summary

Modifier and Type	Method and Description
static void	ensureParameterNotNull(java.lang.Object value) Ensures a parameter is not null.
static void	ensureParameterNotNull(java.lang.Object value, java.lang.String parameterName) Ensures a parameter is not null
static void	ensureThat(boolean condition, java.lang.String message) Ensures that the condition condition holds.
static void	ensureValidCoordinates(EastNorth eastnorth, java.lang.String parameterName) Ensures east/north coordinates are valid
static void	ensureValidCoordinates(LatLon latlon, java.lang.String parameterName) Ensures lat/lon coordinates are valid
static void	ensureValidNodeId(PrimitiveId id, java.lang.String parameterName) Ensures that id is non-null primitive id of type OsmPrimitiveType.NODE
static void	ensureValidPrimitiveId(PrimitiveId id, java.lang.String parameterName) Ensures an OSM primitive ID is valid
static void	ensureValidVersion(long version, java.lang.String parameterName) Ensures a version number is valid

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckParameterUtil

private CheckParameterUtil()

Method Detail

ensureValidPrimitiveId

public static void ensureValidPrimitiveId(PrimitiveId id,
                                          java.lang.String parameterName)
                                   throws java.lang.IllegalArgumentException

Ensures an OSM primitive ID is valid

Parameters:

id - The id to check

parameterName - The parameter name

Throws:

java.lang.IllegalArgumentException - if the primitive ID is not valid (negative or zero)

ensureValidCoordinates

public static void ensureValidCoordinates(LatLon latlon,
                                          java.lang.String parameterName)
                                   throws java.lang.IllegalArgumentException

Ensures lat/lon coordinates are valid

Parameters:

latlon - The lat/lon to check

parameterName - The parameter name

Throws:

java.lang.IllegalArgumentException - if the lat/lon are null or not valid

Since:

5980

ensureValidCoordinates

public static void ensureValidCoordinates(EastNorth eastnorth,
                                          java.lang.String parameterName)
                                   throws java.lang.IllegalArgumentException

Ensures east/north coordinates are valid

Parameters:

eastnorth - The east/north to check

parameterName - The parameter name

Throws:

java.lang.IllegalArgumentException - if the east/north are null or not valid

Since:

5980

ensureValidVersion

public static void ensureValidVersion(long version,
                                      java.lang.String parameterName)
                               throws java.lang.IllegalArgumentException

Ensures a version number is valid

Parameters:

version - The version to check

parameterName - The parameter name

Throws:

java.lang.IllegalArgumentException - if the version is not valid (negative)

ensureParameterNotNull

public static void ensureParameterNotNull(java.lang.Object value,
                                          java.lang.String parameterName)
                                   throws java.lang.IllegalArgumentException

Ensures a parameter is not null

Parameters:

value - The parameter to check

parameterName - The parameter name

Throws:

java.lang.IllegalArgumentException - if the parameter is null

ensureParameterNotNull

public static void ensureParameterNotNull(java.lang.Object value)
                                   throws java.lang.IllegalArgumentException

Ensures a parameter is not null. Can find line number in the stack trace, so parameter name is optional

Parameters:

value - The parameter to check

Throws:

java.lang.IllegalArgumentException - if the parameter is null

Since:

3871

ensureThat

public static void ensureThat(boolean condition,
                              java.lang.String message)
                       throws java.lang.IllegalArgumentException

Ensures that the condition condition holds.

Parameters:

condition - The condition to check

Throws:

java.lang.IllegalArgumentException - if the condition does not hold

ensureValidNodeId

public static void ensureValidNodeId(PrimitiveId id,
                                     java.lang.String parameterName)
                              throws java.lang.IllegalArgumentException

Ensures that id is non-null primitive id of type OsmPrimitiveType.NODE

Parameters:

id - the primitive id

parameterName - the name of the parameter to be checked

Throws:

java.lang.IllegalArgumentException - thrown if id is null

java.lang.IllegalArgumentException - thrown if id.getType() != NODE