org.opendaylight.vtn.manager.internal.util

Class MiscUtils

java.lang.Object

org.opendaylight.vtn.manager.internal.util.MiscUtils

public final class MiscUtils
extends Object

MiscUtils class is a collection of miscellaneous utility class methods.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VLAN_ID Default VLAN ID.
static String	LOG_SEPARATOR A string to be used as a field separator in a log message.
static int	ORDER_MIN The minimum value of the order value for the first element in the ordered list.
static org.slf4j.Logger	VERBOSE_LOG A logger for extra verbose logging.

Method Summary

Modifier and Type	Method and Description
static <T> T	cast(Class<T> type, Object obj) Cast an object type to the specified type.
static VnodeName	checkName(String desc, String name) Check the specified resource name.
static String	checkName(String desc, VnodeName vname) Check the specified resource name.
static void	checkPresent(String desc, VnodeName vname) Ensure the given vnode-name is not null.
static double	doubleValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 c) Return the value in the given 32-bit counter.
static double	doubleValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 c) Return the value in the given 64-bit counter.
static <T extends org.opendaylight.yangtools.yang.binding.Identifiable<?>> boolean	equalsAsMap(Collection<T> c1, Collection<T> c2) Determine whether the given two keyed data object lists are identical or not.
static <T> boolean	equalsAsSet(Collection<T> c1, Collection<T> c2) Determine whether the given two collections are identical or not.
static boolean	equalsUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri u1, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri u2) Determine whether the given two URIs are identical or not.
static String	getValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri uri) Return a string configured in the given URI.
static String	getValue(VnodeName vname) Return a string configured in the given vnode-name.
static org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId	getVlanId(VtnVlanIdField field) Return a VLAN ID configured in the given VtnVlanIdField instance.
static boolean	isBadRequest(Throwable t) Determine whether the given throwable is caused by a bad user request or not.
static boolean	isEmpty(Collection<?> c) Determine whether the given collection is empty or not.
static String	join(String separator, Collection<?> objs) Stringify all the elements in the given collection, and join them with inserting the given separator.
static String	join(String separator, Object... objs) Stringify the given objects, and join them with inserting the given separator.
static String	joinColon(Object... objs) Stringify the given objects, and join them with inserting ": " as a separator.
static long	longValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 c) Return the value in the given 32-bit counter.
static long	longValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 c) Return the value in the given 64-bit counter.
static <T> List<T>	sortedCopy(List<T> list, Comparator<? super T> comp) Return the copy of the given list sorted by the given comparator.
static EtherAddress	toEtherAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac) Convert the given MacAddress instance into an EtherAddress instance.
static String	toLowerCase(String str) Convert all of the characters in the given string to lower case.
static String	toLowerCase(VtnUpdateType type) Convert all of the characters in the given VtnUpdateType name to lower case.
static <T> List<T>	toValueList(Map<?,T> map) Convert values in the given map into a list.
static VnodeState	toVnodeState(boolean b) Convert a boolean value into a VnodeState instance.
static IllegalStateException	unexpected() Return an IllegalStateException which indicates unexpected method is called.
static <T> Set<T>	unmodifiableKeySet(Map<T,?> src) Return an unmodifiable set equivalent to the key set in the given map.
static <T> List<T>	unmodifiableList(List<T> src) Return an unmodifiable list equivalent to the given list.
static <T> Set<T>	unmodifiableSet(Set<T> src) Return an unmodifiable set equivalent to the given set.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress	verify(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac) Verify the given MAC address.

Methods inherited from class java.lang.Object

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

Field Detail

VERBOSE_LOG

public static final org.slf4j.Logger VERBOSE_LOG

A logger for extra verbose logging.

LOG_SEPARATOR

public static final String LOG_SEPARATOR

A string to be used as a field separator in a log message.

See Also:

Constant Field Values

ORDER_MIN

public static final int ORDER_MIN

The minimum value of the order value for the first element in the ordered list.

See Also:

Constant Field Values

DEFAULT_VLAN_ID

public static final int DEFAULT_VLAN_ID

Default VLAN ID.

See Also:

Constant Field Values

Method Detail

toEtherAddress

public static EtherAddress toEtherAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac)
                                   throws RpcException

Convert the given MacAddress instance into an EtherAddress instance.

Parameters:

mac - A MacAddress instance.

Returns:

An EtherAddress instance. null if mac is null.

Throws:

RpcException - The given MAC address is invalid.

checkName

public static VnodeName checkName(String desc,
                                  String name)
                           throws RpcException

Check the specified resource name.

Parameters:

desc - Brief description of the resource.

name - The name of the resource.

Returns:

A VnodeName instance that contains the given name.

Throws:

RpcException - The specified name is invalid.

checkName

public static String checkName(String desc,
                               VnodeName vname)
                        throws RpcException

Check the specified resource name.

Parameters:

desc - Brief description of the resource.

vname - A VnodeName instance.

Returns:

Return the string configured in vname.

Throws:

RpcException - The specified name is invalid.

checkPresent

public static void checkPresent(String desc,
                                VnodeName vname)
                         throws RpcException

Ensure the given vnode-name is not null.

Parameters:

desc - Brief description of the resource.

vname - A VnodeName instance.

Throws:

RpcException - vname is null.

joinColon

public static String joinColon(Object... objs)

Stringify the given objects, and join them with inserting ": " as a separator.

Parameters:

objs - Objects to be joined.

Returns:

A joined string.

join

public static String join(String separator,
                          Object... objs)

Stringify the given objects, and join them with inserting the given separator.

Parameters:

separator - A separater to be inserted.

objs - Objects to be joined.

Returns:

A joined string.

join

public static String join(String separator,
                          Collection<?> objs)

Stringify all the elements in the given collection, and join them with inserting the given separator.

Parameters:

separator - A separater to be inserted.

objs - A collection of objects to be joined.

Returns:

A joined string.

cast

public static <T> T cast(Class<T> type,
                         Object obj)

Cast an object type to the specified type.

Type Parameters:

T - The target type.

Parameters:

type - A class that indicates the target type.

obj - An object to be casted.

Returns:

A casted object if the given object can be casted to the specified type. Otherwise null.

toLowerCase

public static String toLowerCase(String str)

Convert all of the characters in the given string to lower case.

Parameters:

str - A string to be converted.

Returns:

A converted string.

toLowerCase

public static String toLowerCase(VtnUpdateType type)

Convert all of the characters in the given VtnUpdateType name to lower case.

Parameters:

type - A VtnUpdateType instance.

Returns:

A converted string.

unexpected

public static IllegalStateException unexpected()

Return an IllegalStateException which indicates unexpected method is called.

Returns:

An IllegalStateException instance.

longValue

public static long longValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 c)

Return the value in the given 32-bit counter.

Parameters:

c - The 32-bit counter.

Returns:

A long value configured in the given counter. Node that zero is returned if c is invalid.

longValue

public static long longValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 c)

Return the value in the given 64-bit counter.

Parameters:

c - The 64-bit counter.

Returns:

A long value configured in the given counter. Node that zero is returned if c is invalid.

doubleValue

public static double doubleValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 c)

Return the value in the given 32-bit counter.

Parameters:

c - The 32-bit counter.

Returns:

A double value configured in the given counter. Node that zero is returned if c is invalid.

doubleValue

public static double doubleValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 c)

Return the value in the given 64-bit counter.

Parameters:

c - The 64-bit counter.

Returns:

A double value configured in the given counter. Node that zero is returned if c is invalid.

sortedCopy

public static <T> List<T> sortedCopy(List<T> list,
                                     Comparator<? super T> comp)

Return the copy of the given list sorted by the given comparator.

Type Parameters:

T - The type of elements in the list.

Parameters:

list - A list to be copied.

comp - A comparator for the given list.

Returns:

A copy of the given list.

equalsUri

public static boolean equalsUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri u1,
                                org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri u2)

Determine whether the given two URIs are identical or not.

Note that this method compares only strings configured in the given URIs. The type of classes are never compared.

Parameters:

u1 - The first instance to be compared.

u2 - The second instance to be compared.

Returns:

true only if vh1 and vh2 are identical.

equalsAsSet

public static <T> boolean equalsAsSet(Collection<T> c1,
                                      Collection<T> c2)

Determine whether the given two collections are identical or not.

This method compares the given collections as sets. Duplicate elements in the given collections are ignored.

Type Parameters:

T - The type of elements in the given collections.

Parameters:

c1 - The first collections to be compared. null is treated as an empty collection.

c2 - The second collections to be compared. null is treated as an empty collection.

Returns:

true only if c1 and c2 are identical.

equalsAsMap

public static <T extends org.opendaylight.yangtools.yang.binding.Identifiable<?>> boolean equalsAsMap(Collection<T> c1,
                                                                                                      Collection<T> c2)

Determine whether the given two keyed data object lists are identical or not.

This method compares the given collections as map keyed by the key defined by Identifiable. Duplicate elements in the given collections are ignored.

Type Parameters:

T - The type of elements in the given collections.

Parameters:

c1 - The first collections to be compared. null is treated as an empty collection. Note that the collection must not contain null.

c2 - The second collections to be compared. null is treated as an empty collection. Note that the collection must not contain null.

Returns:

true only if c1 and c2 are identical.

getValue

public static String getValue(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri uri)

Return a string configured in the given URI.

Parameters:

uri - An Uri instance.

Returns:

A string configured in the given URI. Note that null is returned if uri is null.

getValue

public static String getValue(VnodeName vname)

Return a string configured in the given vnode-name.

Parameters:

vname - An VnodeName instance.

Returns:

A string configured in the given URI. Note that null is returned if vname is null.

unmodifiableList

public static <T> List<T> unmodifiableList(List<T> src)

Return an unmodifiable list equivalent to the given list.

Type Parameters:

T - The type of elements in the list.

Parameters:

src - The source list.

Returns:

An unmodifiable list. An empty list is returned if src is null.

unmodifiableSet

public static <T> Set<T> unmodifiableSet(Set<T> src)

Return an unmodifiable set equivalent to the given set.

Type Parameters:

T - The type of elements in the set.

Parameters:

src - The source set.

Returns:

An unmodifiable set. An empty set is returned if src is null.

unmodifiableKeySet

public static <T> Set<T> unmodifiableKeySet(Map<T,?> src)

Return an unmodifiable set equivalent to the key set in the given map.

Type Parameters:

T - The type of keys in the map.

Parameters:

src - The source map.

Returns:

An unmodifiable set. An empty set is returned if src is null.

getVlanId

public static org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanId(VtnVlanIdField field)
                                                                                         throws RpcException

Return a VLAN ID configured in the given VtnVlanIdField instance.

Parameters:

field - A VtnVlanIdField instance.

Returns:

A VlanId instance.

Throws:

RpcException - field contains an invalid value.

isBadRequest

public static boolean isBadRequest(Throwable t)

Determine whether the given throwable is caused by a bad user request or not.

Parameters:

t - A throwable to be tested.

Returns:

true only if the given throwable is caused by a bad user request.

toValueList

public static <T> List<T> toValueList(Map<?,T> map)

Convert values in the given map into a list.

Type Parameters:

T - The type of values in the given map.

Parameters:

map - A map to be converted.

Returns:

A list of values in the given map if the given map contains at least one value. null if the given map is null or empty.

isEmpty

public static boolean isEmpty(Collection<?> c)

Determine whether the given collection is empty or not.

Parameters:

c - A collection to be tested.

Returns:

true only of the given collection is empty.

toVnodeState

public static VnodeState toVnodeState(boolean b)

Convert a boolean value into a VnodeState instance.

Parameters:

b - A boolean value.

Returns:

VnodeState.UP if b is true. VnodeState.DOWN if b is false.

verify

public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress verify(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac)
                                                                                                            throws RpcException

Verify the given MAC address.

Parameters:

mac - The MAC address to be tested.

Returns:

The given MAC address is returned.

Throws:

RpcException - The given MAC address is invalid.