agi.foundation.geometry

(agi.foundation.core-2024r3.jar)

Class PointHelper

java.lang.Object

agi.foundation.geometry.PointHelper

public final class PointHelper
extends Object

A collection of helper methods for working with Point and related types.

Method Summary

Modifier and Type	Method and Description
static ILocationPointService	getLocationPointService(IServiceProvider provider) Gets the ILocationPointService provided by an object.
static ILocationPointService	getLocationPointService(IServiceProvider provider, String exceptionMessage) Gets the ILocationPointService provided by an object.
static ILocationPointService	getOptionalLocationPointService(IServiceProvider provider) Gets the ILocationPointService provided by an object, or null if the service does not exist.
static Point	getPoint(IServiceProvider provider) Gets the Point from the ILocationPointService provided by an object.
static Point	getPoint(IServiceProvider provider, String exceptionMessage) Gets the Point from the ILocationPointService provided by an object.

Methods inherited from class java.lang.Object

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

Method Detail

getLocationPointService

@Nonnull
public static ILocationPointService getLocationPointService(@Nonnull
                                                                      IServiceProvider provider)

Gets the ILocationPointService provided by an object.

Parameters:

provider - The object from which to obtain the service.

Returns:

The service provided by the object.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide ILocationPointService.

getLocationPointService

@Nonnull
public static ILocationPointService getLocationPointService(@Nonnull
                                                                      IServiceProvider provider,
                                                                      String exceptionMessage)

Gets the ILocationPointService provided by an object.

Parameters:

provider - The object from which to obtain the service.

exceptionMessage - An error message to include in the exception if the service is unavailable.

Returns:

The service provided by the object.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide ILocationPointService.

getOptionalLocationPointService

@Nullable
public static ILocationPointService getOptionalLocationPointService(@Nonnull
                                                                               IServiceProvider provider)

Gets the ILocationPointService provided by an object, or null if the service does not exist.

Parameters:

provider - The object from which to obtain the service.

Returns:

The service provided by the object, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when provider is null.

getPoint

public static Point getPoint(@Nonnull
                             IServiceProvider provider)

Gets the Point from the ILocationPointService provided by an object.

Parameters:

provider - The object from which to obtain the ILocationPointService service.

Returns:

The Point from the ILocationPointService.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide ILocationPointService.

getPoint

public static Point getPoint(@Nonnull
                             IServiceProvider provider,
                             String exceptionMessage)

Gets the Point from the ILocationPointService provided by an object.

Parameters:

provider - The object from which to obtain the ILocationPointService service.

exceptionMessage - An error message to include in the exception if the ILocationPointService service is unavailable.

Returns:

The Point from the ILocationPointService.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide ILocationPointService.