TheWayOut 2008

de.thewayout.o8.api
Class BaseObject

java.lang.Object
  extended by de.thewayout.o8.api.BaseObject
Direct Known Subclasses:
AbstractStrategy, Coordinates, Course, Position, Route, Standalone

public class BaseObject
extends java.lang.Object

Stellt allgemeine Hilfsmethoden bereit, die in allen Klassen verwendet werden können und sollten.
Diese Methoden haben scheinbar nur kosmetische Wirkung, weil sie "nur" die Lesbarkeit des Quelltextes erhöhen. Da sie andererseits aber keine Performance-Nachteile mit sich bringen (sie können vom Compiler inline optimiert werden), ist diese erhöhte Lesbarkeit unterm Strich ein wirklich erhebliches Plus.

Author:
ObjectFab GmbH

Constructor Summary
BaseObject()
           
 
Method Summary
static boolean areNotNull(java.lang.Object... refs)
          Prüft alle übergebenen Referenzen, ob sie dereferenzierbar (nicht null) sind.
static
<T> java.util.List<T>
createList(java.lang.Class<T> clazz)
          Factory-Methode für eine Liste von Instanzen einer konkreten Klasse.
static boolean isEmpty(java.util.Collection<?> collection)
          Prüft, ob die übergebene Referenz ungültig oder die Collection dahinter leer ist.
static boolean isEmpty(java.lang.Object[] array)
          Prüft, ob die übergebene Referenz ungültig oder das Array dahinter leer ist.
static boolean isEmpty(java.lang.String s)
          Prüft, ob die übergebene Referenz ungültig oder der String dahinter leer ist.
static boolean isEmpty(java.lang.StringBuffer sb)
          Prüft, ob die übergebene Referenz ungültig oder der StringBuffer dahinter leer ist.
static boolean isNotEmpty(java.util.Collection<?> collection)
          Prüft, ob die übergebene Referenz gültig ist und die Collection dahinter mindestens ein Element enthält.
static boolean isNotEmpty(java.lang.Object[] array)
          Prüft, ob die übergebene Referenz gültig ist und das Array dahinter mindestens ein Element enthält.
static boolean isNotEmpty(java.lang.String string)
          Prüft, ob die übergebene Referenz gültig ist und der String dahinter mindestens ein Element enthält.
static boolean isNotEmpty(java.lang.StringBuffer sb)
          Prüft, ob die übergebene Referenz gültig ist und der StringBuffer dahinter mindestens ein Zeichen enthält.
static boolean isNotNull(java.lang.Object ref)
          Prüft eine übergebene Referenz, ob sie dereferenzierbar (nicht null) ist.
static boolean isNull(java.lang.Object ref)
          Prüft eine übergebene Referenz, ob sie null ist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseObject

public BaseObject()
Method Detail

createList

public static <T> java.util.List<T> createList(java.lang.Class<T> clazz)
Factory-Methode für eine Liste von Instanzen einer konkreten Klasse.

Parameters:
clazz - die Klasse, die in der Liste gehalten werden soll
Returns:
eine neue, leere Liste

isNull

public static boolean isNull(java.lang.Object ref)
Prüft eine übergebene Referenz, ob sie null ist. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
ref - die zu prüfende Referenz
Returns:
true, wenn die übergebene Referenz null war, sonst false

isNotNull

public static boolean isNotNull(java.lang.Object ref)
Prüft eine übergebene Referenz, ob sie dereferenzierbar (nicht null) ist. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
ref - die zu prüfende Referenz
Returns:
true, wenn die übergebene Referenz dereferenziert werden kann, sonst false

areNotNull

public static boolean areNotNull(java.lang.Object... refs)
Prüft alle übergebenen Referenzen, ob sie dereferenzierbar (nicht null) sind. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
refs - beliebige, zu prüfende Referenzen
Returns:
true, wenn alle übergebenen Referenz dereferenziert werden können, sonst false

isEmpty

public static boolean isEmpty(java.lang.String s)
Prüft, ob die übergebene Referenz ungültig oder der String dahinter leer ist. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
s - die zu prüfende String-Referenz
Returns:
true, wenn die Referenz null oder der referenzierte String leer ist, sonst false

isEmpty

public static boolean isEmpty(java.lang.StringBuffer sb)
Prüft, ob die übergebene Referenz ungültig oder der StringBuffer dahinter leer ist. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
sb - die zu prüfende StringBuffer-Referenz
Returns:
true, wenn die Referenz null oder der referenzierte StringBuffer leer ist, sonst false

isEmpty

public static boolean isEmpty(java.lang.Object[] array)
Prüft, ob die übergebene Referenz ungültig oder das Array dahinter leer ist. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
array - die zu prüfende Array-Referenz
Returns:
true, wenn die Referenz null oder das referenzierte Array leer ist, sonst false

isEmpty

public static boolean isEmpty(java.util.Collection<?> collection)
Prüft, ob die übergebene Referenz ungültig oder die Collection dahinter leer ist. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
collection - die zu prüfende Collection-Referenz
Returns:
true, wenn die Referenz null oder die referenzierte Collection leer ist, sonst false

isNotEmpty

public static boolean isNotEmpty(java.lang.String string)
Prüft, ob die übergebene Referenz gültig ist und der String dahinter mindestens ein Element enthält. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
string - die zu prüfende String-Referenz
Returns:
true, wenn die Referenz gültig und der referenzierte String mindestens ein Zeichen enthält, sonst false

isNotEmpty

public static boolean isNotEmpty(java.lang.StringBuffer sb)
Prüft, ob die übergebene Referenz gültig ist und der StringBuffer dahinter mindestens ein Zeichen enthält. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
sb - die zu prüfende StringBuffer-Referenz
Returns:
true, wenn die Referenz gültig und die referenzierte Stringbuffer mindestens ein Element enthält, sonst false

isNotEmpty

public static boolean isNotEmpty(java.lang.Object[] array)
Prüft, ob die übergebene Referenz gültig ist und das Array dahinter mindestens ein Element enthält. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
array - die zu prüfende Array-Referenz
Returns:
true, wenn die Referenz gültig und das referenzierte Array mindestens ein Element enthält, sonst false

isNotEmpty

public static boolean isNotEmpty(java.util.Collection<?> collection)
Prüft, ob die übergebene Referenz gültig ist und die Collection dahinter mindestens ein Element enthält. Diese scheinbar belanglose Funktion erhöht (wenn sie konsequent eingesetzt wird) die Lesbarkeit des Quelltextes beachtlich. Der Compiler kann ein Inlining durchführen, es entstehen also auch keine Performance-Nachteile.

Parameters:
collection - die zu prüfende Collection-Referenz
Returns:
true, wenn die Referenz gültig und die referenzierte Collection mindestens ein Element enthält, sonst false

© ObjectFab GmbH 2008