org.gridgain.grid.util.typedef

Class X

java.lang.Object

org.gridgain.grid.util.typedef.X

public final class X
extends Object

Defines global scope.

Contains often used utility functions allowing to cut down on code bloat. This is somewhat analogous to Predef in Scala. Note that this should only be used when this typedef does not sacrifice the code readability.

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends Throwable> T	cause(Throwable t, Class<T> cls) Gets first cause if passed in 'Throwable' has given class in 'cause' hierarchy.
static void	checkMinMemory(long min) Exits with code -1 if maximum memory is below 90% of minimally allowed threshold.
static <T> T	cloneObject(T obj, boolean deep, boolean honorCloneable) Clones a passed in object.
static int	copy(InputStream in, OutputStream out, int bufSize) Copies input byte stream to output byte stream.
static void	error(String s1, Object... rest) Alias for System.err.println.
static String	formatMins(long mins) Pretty-formatting for minutes.
static String	getSystemOrEnv(String name) Gets either system property or environment variable with given name.
static String	getSystemOrEnv(String name, String dflt) Gets either system property or environment variable with given name.
static boolean	hasCause(Throwable t, Class<? extends Throwable>... cls) Checks if passed in 'Throwable' has given class in 'cause' hierarchy including that throwable itself.
static boolean	hasCauseExcludeRoot(Throwable t, Class<? extends Throwable>... cls) Checks if passed in 'Throwable' has given class in 'cause' hierarchy excluding that throwable itself.
static double	parseDouble(String s, double dflt) Parses double from possibly null or invalid string.
static void	print(String s1, Object... rest) Alias for System.out.print.
static void	printerr(String s1, Object... rest) Alias for System.err.print.
static void	printerrln() Alias for System.err.println().
static void	printerrln(String s1, Object... rest) Alias for System.err.println.
static void	println() Alias for System.out.println().
static void	println(String s1, Object... rest) Alias for System.out.println.
static String	resolveGridGainHome() Tries to resolve GridGain installation home folder.
static String	timeSpan2HMS(long span) Creates string presentation of given time span in hh:mm:ss HMS format.
static String	timeSpan2HMSM(long span) Creates string presentation of given time span in hh:mm:ss:msec HMSM format.
static void	waitAll(Iterable<GridFuture<?>> futs) Synchronously waits for all futures in the collection.

Methods inherited from class java.lang.Object

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

Method Detail

println

public static void println()

Alias for System.out.println().

printerrln

public static void printerrln()

Alias for System.err.println().

println

public static void println(@Nullable
           String s1,
           @Nullable
           Object... rest)

Alias for System.out.println.

Parameters:

s1 - First string to print.

rest - Optional list of objects to print as well.

printerrln

public static void printerrln(@Nullable
              String s1,
              @Nullable
              Object... rest)

Alias for System.err.println.

Parameters:

s1 - First string to print.

rest - Optional list of objects to print as well.

error

public static void error(@Nullable
         String s1,
         @Nullable
         Object... rest)

Alias for System.err.println.

Parameters:

s1 - First string to print.

rest - Optional list of objects to print as well.

print

public static void print(@Nullable
         String s1,
         @Nullable
         Object... rest)

Alias for System.out.print.

Parameters:

s1 - First string to print.

rest - Optional list of objects to print as well.

printerr

public static void printerr(@Nullable
            String s1,
            @Nullable
            Object... rest)

Alias for System.err.print.

Parameters:

s1 - First string to print.

rest - Optional list of objects to print as well.

getSystemOrEnv

@Nullable
public static String getSystemOrEnv(String name)

Gets either system property or environment variable with given name.

Parameters:

name - Name of the system property or environment variable.

Returns:

Value of the system property or environment variable. Returns null if neither can be found for given name.

getSystemOrEnv

@Nullable
public static String getSystemOrEnv(String name,
                             String dflt)

Gets either system property or environment variable with given name.

Parameters:

name - Name of the system property or environment variable.

dflt - Default value.

Returns:

Value of the system property or environment variable. Returns null if neither can be found for given name.

timeSpan2HMSM

public static String timeSpan2HMSM(long span)

Creates string presentation of given time span in hh:mm:ss:msec HMSM format.

Parameters:

span - Time span.

Returns:

String presentation.

timeSpan2HMS

public static String timeSpan2HMS(long span)

Creates string presentation of given time span in hh:mm:ss HMS format.

Parameters:

span - Time span.

Returns:

String presentation.

cloneObject

@Nullable
public static <T> T cloneObject(@Nullable
                         T obj,
                         boolean deep,
                         boolean honorCloneable)

Clones a passed in object. If parameter deep is set to true then this method will use deep cloning algorithm based on deep reflection ignoring Cloneable interface unless parameter honorCloneable is set to false.

If deep is false then this method will check the object for Cloneable interface and use Object.clone() to make a copy, otherwise the object itself will be returned.

Type Parameters:

T - Type of cloning object.

Parameters:

obj - Object to create a clone from.

deep - true to use algorithm of deep cloning. If false then this method will always be checking whether a passed in object implements interface Cloneable and if it does then method Object.clone() will be used to clone object, if does not then the object itself will be returned.

honorCloneable - Flag indicating whether Cloneable interface should be honored or not when cloning. This parameter makes sense only if parameter deep is set to true.

Returns:

Copy of a passed in object.

hasCause

public static boolean hasCause(@Nullable
               Throwable t,
               @Nullable
               Class<? extends Throwable>... cls)

Checks if passed in 'Throwable' has given class in 'cause' hierarchy including that throwable itself.

Note that this method follows includes Throwable.getSuppressed() into check.

Parameters:

t - Throwable to check (if null, false is returned).

cls - Cause classes to check (if null or empty, false is returned).

Returns:

True if one of the causing exception is an instance of passed in classes, false otherwise.

hasCauseExcludeRoot

public static boolean hasCauseExcludeRoot(@Nullable
                          Throwable t,
                          @Nullable
                          Class<? extends Throwable>... cls)

Checks if passed in 'Throwable' has given class in 'cause' hierarchy excluding that throwable itself.

Note that this method follows includes Throwable.getSuppressed() into check.

Parameters:

t - Throwable to check (if null, false is returned).

cls - Cause classes to check (if null or empty, false is returned).

Returns:

True if one of the causing exception is an instance of passed in classes, false otherwise.

cause

@Nullable
public static <T extends Throwable> T cause(@Nullable
                                     Throwable t,
                                     @Nullable
                                     Class<T> cls)

Gets first cause if passed in 'Throwable' has given class in 'cause' hierarchy.

Note that this method follows includes Throwable.getSuppressed() into check.

Parameters:

t - Throwable to check (if null, null is returned).

cls - Cause class to get cause (if null, null is returned).

Returns:

First causing exception of passed in class, null otherwise.

waitAll

public static void waitAll(@Nullable
           Iterable<GridFuture<?>> futs)
                    throws GridException

Synchronously waits for all futures in the collection.

Parameters:

futs - Futures to wait for.

Throws:

GridException - If any of the futures threw exception.

formatMins

public static String formatMins(long mins)

Pretty-formatting for minutes.

Parameters:

mins - Minutes to format.

Returns:

Formatted presentation of minutes.

checkMinMemory

public static void checkMinMemory(long min)

Exits with code -1 if maximum memory is below 90% of minimally allowed threshold.

Parameters:

min - Minimum memory threshold.

copy

public static int copy(InputStream in,
       OutputStream out,
       int bufSize)
                throws IOException

Copies input byte stream to output byte stream.

Parameters:

in - Input byte stream.

out - Output byte stream.

bufSize - Intermediate buffer size.

Returns:

Number of the copied bytes.

Throws:

IOException - Thrown if an I/O error occurs.

resolveGridGainHome

public static String resolveGridGainHome()
                                  throws GridException

Tries to resolve GridGain installation home folder.

Returns:

Installation home folder.

Throws:

GridException - If GridGain home folder was not set.

parseDouble

public static double parseDouble(@Nullable
                 String s,
                 double dflt)

Parses double from possibly null or invalid string.

Parameters:

s - String to parse double from. If string is null or invalid, a default value is used.

dflt - Default value for double, if parsing failed.

Returns:

Resulting double.