gov.nist.microanalysis.EPQLibrary
Class CaveatBase

java.lang.Object
  gov.nist.microanalysis.EPQLibrary.CaveatBase

public class CaveatBase
extends java.lang.Object

Provides a standardized base set of static items for use in caveats - a mechanism for identifying an algorithms limitations.

Copyright: Pursuant to title 17 Section 105 of the United States Code this software is not subject to copyright protection and is in the public domain

Company: National Institute of Standards and Technology

Version:

1.0

Author:

Nicholas W. M. Ritchie

Field Summary

static java.lang.String	Broken
static java.lang.String	None
static java.lang.String	NotImplemented

Constructor Summary

CaveatBase()

Method Summary

static java.lang.String	append(java.lang.String base, java.lang.String str) appendCaveat - Append a new caveat to a list of existing caveats.
static java.lang.String	format(java.lang.Object obj, java.lang.String str) formatCaveat - Format the caveat in such a way that the algorithm is identified along with the caveat.
static boolean	isBroken(java.lang.String str) isBroken - Is this implementation broken?
static boolean	isNone(java.lang.String str) isNone - Are there no caveats identified with this algorithm?
static boolean	isNotImplemented(java.lang.String str) isNotImplemented - Is this algorithm not implemented?

Methods inherited from class java.lang.Object

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

Field Detail

None

public static final java.lang.String None

See Also:

Constant Field Values

Broken

public static final java.lang.String Broken

See Also:

Constant Field Values

NotImplemented

public static final java.lang.String NotImplemented

See Also:

Constant Field Values

Constructor Detail

CaveatBase

public CaveatBase()

Method Detail

isBroken

public static boolean isBroken(java.lang.String str)

isBroken - Is this implementation broken?

Parameters:

str - String - The result from a call to a caveat method

Returns:

boolean

isNone

public static boolean isNone(java.lang.String str)

isNone - Are there no caveats identified with this algorithm?

Parameters:

str - String - The result from a call to a caveat method

Returns:

boolean

isNotImplemented

public static boolean isNotImplemented(java.lang.String str)

isNotImplemented - Is this algorithm not implemented?

Parameters:

str - String - The result from a call to a caveat method

Returns:

boolean

append

public static java.lang.String append(java.lang.String base,
                                      java.lang.String str)

appendCaveat - Append a new caveat to a list of existing caveats. If one or both is CaveatBase.None this is handled correctly. If both are CaveatBase.None then CaveatBase.None is returned.

Parameters:

base - String

str - String

Returns:

String

format

public static java.lang.String format(java.lang.Object obj,
                                      java.lang.String str)

formatCaveat - Format the caveat in such a way that the algorithm is identified along with the caveat. If the caveat equals CaveatBase.None then CaveatBase.None is returned.

Parameters:

obj - Object

str - String

Returns:

String