org.g_node.nix.valid

Class Result

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.valid.Result

@Platform(include="<nix/valid/result.hpp>") @Platform(value="linux",link="nix@.1",preload="hdf5@.7") @Platform(value="windows",link="nix",preload={"hdf5","msvcp120","msvcr120","szip","zlib"})
 @Namespace(value="nix::valid")
 @NoOffset
public class Result
extends org.bytedeco.javacpp.Pointer

Result

Class used to store error and warning messages.

Constructor Summary

Constructors

Constructor and Description
Result() Constructor
Result(List<Message> errs, List<Message> warns) Standard constructor.
Result(Message err, Message warn) Standard constructor.

Method Summary

Modifier and Type	Method and Description
Result	addError(Message error) Adds an error message Adds an error message to this Result object and returns a reference to this object.
Result	addWarning(Message warning) Adds a warning message Adds a warning message to this Result object and returns a reference to this object.
Result	concat(Result result) Appends the warnings & errors of given Result to this one Concatenates the errors and warnings lists of the given Result object to those if this Result object and returns a reference to this object.
List<Message>	getErrors() Returns the errors list.
List<Message>	getWarnings() Returns the warnings list.
boolean	hasErrors() Returns true if no error msgs added at all Returns false if no errors have been added, thus list is empty.
boolean	hasWarnings() Returns true if no warning msgs added at all Returns false if no warnings have been added, thus list is empty.
boolean	isOK() Returns true if no msgs added at all Returns true if neither errors nor warnings have been added, thus both lists are empty.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, position, put, setNull, sizeof, toString, zero

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Result

public Result()

Constructor

Result

public Result(List<Message> errs,
              List<Message> warns)

Standard constructor.

Standard constructor that expects a list of error msgs and a list of warning msgs. Pass null if not present.

Parameters:

errs - List of error messages

warns - List of warning messages

See Also:

Message

Result

public Result(Message err,
              Message warn)

Standard constructor.

Standard constructor that expects an error msg and a warning msg. Pass null if not present.

Parameters:

err - error message

warn - warning message

See Also:

Message

Method Detail

getWarnings

public List<Message> getWarnings()

Returns the warnings list.

Returns:

list of warning msgs

See Also:

Message

getErrors

public List<Message> getErrors()

Returns the errors list.

Returns:

list of error msgs

See Also:

Message

concat

@ByVal
public Result concat(@Const @ByRef
                            Result result)

Appends the warnings & errors of given Result to this one

Concatenates the errors and warnings lists of the given Result object to those if this Result object and returns a reference to this object.

Returns:

reference to this Result

addError

@ByVal
public Result addError(@Const @ByRef
                              Message error)

Adds an error message

Adds an error message to this Result object and returns a reference to this object.

Returns:

reference to this Result

See Also:

Message

addWarning

@ByVal
public Result addWarning(@Const @ByRef
                                Message warning)

Adds a warning message

Adds a warning message to this Result object and returns a reference to this object.

Returns:

reference to this Result

See Also:

Message

isOK

@Name(value="ok")
 @Cast(value="bool")
public boolean isOK()

Returns true if no msgs added at all

Returns true if neither errors nor warnings have been added, thus both lists are empty. Returns false otherwise.

Returns:

bool indicating whether no msgs added at all

hasErrors

@Cast(value="bool")
public boolean hasErrors()

Returns true if no error msgs added at all

Returns false if no errors have been added, thus list is empty. Returns true otherwise.

Returns:

bool indicating whether error msgs added

hasWarnings

@Cast(value="bool")
public boolean hasWarnings()

Returns true if no warning msgs added at all

Returns false if no warnings have been added, thus list is empty. Returns true otherwise.

Returns:

bool indicating whether warning msgs added