Package net.solarnetwork.node.service.support

Class BasicPlatformPackageResult<T>

java.lang.Object

net.solarnetwork.node.service.support.BasicPlatformPackageResult<T>

Type Parameters:

T - the context type

All Implemented Interfaces:

PlatformPackageService.PlatformPackageResult<T>

public class BasicPlatformPackageResult<T>
extends Object
implements PlatformPackageService.PlatformPackageResult<T>

A basic, immutable implementation of PlatformPackageService.PlatformPackageResult.

Since:

1.68

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
BasicPlatformPackageResult(boolean success, String message, Throwable exception, List<Path> extractedPaths, T context)	Constructor.

Method Summary

Modifier and Type	Method	Description
T	getContext()	Get the context object.
Throwable	getException()	Get a result exception.
List<Path>	getExtractedPaths()	Get a complete list of files installed from the package.
String	getMessage()	Get a result message.
boolean	isSuccess()	Get the success flag.

Methods inherited from class java.lang.Object

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

Constructor Details

BasicPlatformPackageResult

public BasicPlatformPackageResult(boolean success,
 String message,
 Throwable exception,
 List<Path> extractedPaths,
 T context)

Constructor.

Parameters:

success - the success flag

message - the message

exception - the exception

extractedPaths - the extracted paths

context - the context

Method Details

isSuccess

public boolean isSuccess()

Description copied from interface: PlatformPackageService.PlatformPackageResult

Get the success flag.

Specified by:

isSuccess in interface PlatformPackageService.PlatformPackageResult<T>

Returns:

true if the package was extracted successfully

getMessage

public String getMessage()

Description copied from interface: PlatformPackageService.PlatformPackageResult

Get a result message.

Specified by:

getMessage in interface PlatformPackageService.PlatformPackageResult<T>

Returns:

a result message (or null)

getException

public Throwable getException()

Description copied from interface: PlatformPackageService.PlatformPackageResult

Get a result exception.

Specified by:

getException in interface PlatformPackageService.PlatformPackageResult<T>

Returns:

an exception, or null if no exception occurred

getExtractedPaths

public List<Path> getExtractedPaths()

Description copied from interface: PlatformPackageService.PlatformPackageResult

Get a complete list of files installed from the package.

Specified by:

getExtractedPaths in interface PlatformPackageService.PlatformPackageResult<T>

Returns:

the extracted paths, or null if nothing installed

getContext

public T getContext()

Description copied from interface: PlatformPackageService.PlatformPackageResult

Get the context object.

Specified by:

getContext in interface PlatformPackageService.PlatformPackageResult<T>

Returns:

the context object