net.sf.mmm.util.exception.api

Class NlsNullPointerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.mmm.util.exception.api.NlsRuntimeException

net.sf.mmm.util.exception.api.NlsNullPointerException

All Implemented Interfaces:

Serializable, Cloneable, NlsThrowable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, NlsObject

public class NlsNullPointerException
extends NlsRuntimeException

A NlsNullPointerException is analog to an NullPointerException but with native language support.

Since:

1.0.2

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_CODE
private static long	serialVersionUID

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NlsNullPointerException() The constructor for de-serialization in GWT.
	NlsNullPointerException(String argument) The constructor.
	NlsNullPointerException(String argument, Throwable nested) The constructor.

Method Summary

Modifier and Type	Method and Description
static <O> void	checkNotNull(Class<O> type, O object) This method checks if the given object is null.
static void	checkNotNull(String objectName, Object object) This method checks if the given object is null.
String	getCode() This method gets the code that identifies the detailed type of this object.

Methods inherited from class net.sf.mmm.util.exception.api.NlsRuntimeException

createBundle, createCopy, createCopyViaClone, createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, printStackTrace, toNlsMessage, toString, toString, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.exception.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

Constructor Detail

NlsNullPointerException

protected NlsNullPointerException()

The constructor for de-serialization in GWT.

NlsNullPointerException

public NlsNullPointerException(String argument)

The constructor.

Parameters:

argument - is the argument that is illegal. May be null.

NlsNullPointerException

public NlsNullPointerException(String argument,
                               Throwable nested)

The constructor.

Parameters:

argument - is the argument that is illegal. May be null.

nested - is the cause of this exception.

Method Detail

checkNotNull

public static <O> void checkNotNull(Class<O> type,
                                    O object)
                             throws NlsNullPointerException

This method checks if the given object is null.
ATTENTION:
This method is only intended to be used for specific types. It then not only saves you from a single if -statement, but also defines a common pattern that is refactoring-safe.
Anyhow you should never use this method with generic Classes for type such as Object, String, Integer, etc.

Here is an example:

 public void myMethod(MySpecificBusinessObject businessObject, String someParameter) {
   NlsNullPointerException.checkNotNull(MySpecificBusinessObject.class, businessObject);
   NlsNullPointerException.checkNotNull("someParameter", someParameter);
   doTheWork();
 }
 

Type Parameters:

O - is the generic type of the object.

Parameters:

type - is the class reflecting the object. Its simple name will be used in the exception-message if object is null.

object - is the object that is checked and should NOT be null.

Throws:

NlsNullPointerException - if the given object is null.

checkNotNull

public static void checkNotNull(String objectName,
                                Object object)
                         throws NlsNullPointerException

This method checks if the given object is null.
Look at the following example:

 NlsNullPointerException.checkNotNull("someParameter", someParameter);
 

This is equivalent to this code:

 if (someParameter == null) {
   throw new NlsNullPointerException("someParameter");
 }
 

Parameters:

objectName - is the (argument-)name of the given object.

object - is the object that is checked and should NOT be null.

Throws:

NlsNullPointerException - if the given object is null.

Since:

2.0.0

getCode

public String getCode()

Description copied from interface: AttributeReadMessageCode

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Overrides:

getCode in class NlsRuntimeException

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message