com.verhas.utils

Class Sugar

java.lang.Object

com.verhas.utils.Sugar

public class Sugar
extends Object

Some static function to be used in other classes to have some syntactic sugar. Some day I will move these to a separate package so that you can import it from maven repo to other projects. At the moment they are small and simple, copy them if you like.

Author:

Peter Verhas

Constructor Summary

Constructors

Constructor and Description
Sugar()

Method Summary

Modifier and Type	Method and Description
static <T> Iterable<T>	in(Iterator<T> iterator) Use this method to create a new style (java 1.5+) 'for' loop when some old library method returns iterator.
static boolean	matchesAny(String string, Set<String> regexSet)
static <T> T	to(T t) For documentation see using(java.lang.Object).
static <T> T	using(T t) Simple syntactic sugar to provide some reading information to the code.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sugar

public Sugar()

Method Detail

in

public static <T> Iterable<T> in(Iterator<T> iterator)

Use this method to create a new style (java 1.5+) 'for' loop when some old library method returns iterator. For example the PGPSecretKeyRingCollection.getKeyRings() returns an Iterator. You can write the code

 for (final PGPSecretKeyRing kRing : in((Iterator) pgpSec
 .getKeyRings())) {
 ...
 }
 

(actual code was copied from License.java).

Type Parameters:

T - note that you can not pass a raw Iterator. You have to cast it to the specific generic type Iterator as in the example above.

Parameters:

iterator - is 'converted'

Returns:

an Iterable that will iterate through the elements of the iterator

using

public static <T> T using(T t)

Simple syntactic sugar to provide some reading information to the code. You can use this method to embrace any argument when a method is called. For example:

 encode(licensePlain, using(signatureGenerator), to(outputStream));
 

(actual code was copied from License.java). to(java.lang.Object) is also a similar method.

Note that these methods increase the size of the VM code, but any modern Java implementation will optimize them off in the JIT phase.

Type Parameters:

T -

Parameters:

t - argument to pass back on to the called

Returns:

the argument as it is.

to

public static <T> T to(T t)

For documentation see using(java.lang.Object).

Type Parameters:

T -

Parameters:

t -

Returns:

matchesAny

public static boolean matchesAny(String string,
                                 Set<String> regexSet)

Parameters:

string - to match

regexSet - regular expressions provided as set of strings

Returns:

true if the string matches any of the regular expressions