Tools (onlab-misc 1.1.0 API)

java.lang.Object
- org.onlab.util.Tools

public abstract class Tools
extends Object

Miscellaneous utility methods.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copyDirectory(File src, File dst)` Copies the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in copy of unintended files.
`static void`	`copyDirectory(String src, String dst)` Copies the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in copy of unintended files.
`static void`	`delay(int ms)` Suspends the current thread for a specified number of millis.
`static long`	`fromHex(String string)` Converts a string from hex to long.
`static String`	`get(Dictionary<?,?> properties, String propertyName)` Get property as a string value.
`static ThreadFactory`	`groupedThreads(String groupName, String pattern)` Returns a thread factory that produces threads named according to the supplied name pattern and from the specified thread-group.
`static boolean`	`isNullOrEmpty(Collection collection)` Returns true if the collection is null or is empty.
`static ThreadFactory`	`minPriority(ThreadFactory factory)` Returns a thread factory that produces threads with MIN_PRIORITY.
`static ThreadFactory`	`namedThreads(String pattern)` Returns a thread factory that produces threads named according to the supplied name pattern.
`static void`	`removeDirectory(File dir)` Purges the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in deletion of unintended files.
`static void`	`removeDirectory(String path)` Purges the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in deletion of unintended files.
`static List<String>`	`slurp(File path)` Slurps the contents of a file into a list of strings, one per line.
`static String`	`timeAgo(long unixTime)` Returns a human friendly time ago string for a specified system time.
`static String`	`toHex(long value)` Converts a long value to hex string; 16 wide and sans 0x.
`static String`	`toHex(long value, int width)` Converts a long value to hex string; 16 wide and sans 0x.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - namedThreads
```
public static ThreadFactory namedThreads(String pattern)
```
    Returns a thread factory that produces threads named according to the supplied name pattern.
    
    Parameters:
    
    pattern - name pattern
    
    Returns:
    
    thread factory
  - groupedThreads
```
public static ThreadFactory groupedThreads(String groupName,
                                           String pattern)
```
    Returns a thread factory that produces threads named according to the supplied name pattern and from the specified thread-group. The thread group name is expected to be specified in slash-delimited format, e.g. onos/intent. The thread names will be produced by converting the thread group name into dash-delimited format and pre-pended to the specified pattern.
    
    Parameters:
    
    groupName - group name in slash-delimited format to indicate hierarchy
    
    pattern - name pattern
    
    Returns:
    
    thread factory
  - minPriority
```
public static ThreadFactory minPriority(ThreadFactory factory)
```
    Returns a thread factory that produces threads with MIN_PRIORITY.
    
    Parameters:
    
    factory - backing ThreadFactory
    
    Returns:
    
    thread factory
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(Collection collection)
```
    Returns true if the collection is null or is empty.
    
    Parameters:
    
    collection - collection to test
    
    Returns:
    
    true if null or empty; false otherwise
  - fromHex
```
public static long fromHex(String string)
```
    Converts a string from hex to long.
    
    Parameters:
    
    string - hex number in string form; sans 0x
    
    Returns:
    
    long value
  - toHex
```
public static String toHex(long value)
```
    Converts a long value to hex string; 16 wide and sans 0x.
    
    Parameters:
    
    value - long value
    
    Returns:
    
    hex string
  - toHex
```
public static String toHex(long value,
                           int width)
```
    Converts a long value to hex string; 16 wide and sans 0x.
    
    Parameters:
    
    value - long value
    
    width - string width; zero padded
    
    Returns:
    
    hex string
  - get
```
public static String get(Dictionary<?,?> properties,
                         String propertyName)
```
    Get property as a string value.
    
    Parameters:
    
    properties - properties to be looked up
    
    propertyName - the name of the property to look up
    
    Returns:
    
    value when the propertyName is defined or return null
  - delay
```
public static void delay(int ms)
```
    Suspends the current thread for a specified number of millis.
    
    Parameters:
    
    ms - number of millis
  - slurp
```
public static List<String> slurp(File path)
```
    Slurps the contents of a file into a list of strings, one per line.
    
    Parameters:
    
    path - file path
    
    Returns:
    
    file contents
  - removeDirectory
```
public static void removeDirectory(String path)
                            throws IOException
```
    Purges the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in deletion of unintended files.
    
    Parameters:
    
    path - directory to be removed
    
    Throws:
    
    IOException - if unable to remove contents
  - removeDirectory
```
public static void removeDirectory(File dir)
                            throws IOException
```
    Purges the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in deletion of unintended files.
    
    Parameters:
    
    dir - directory to be removed
    
    Throws:
    
    IOException - if unable to remove contents
  - timeAgo
```
public static String timeAgo(long unixTime)
```
    Returns a human friendly time ago string for a specified system time.
    
    Parameters:
    
    unixTime - system time in millis
    
    Returns:
    
    human friendly time ago
  - copyDirectory
```
public static void copyDirectory(String src,
                                 String dst)
                          throws IOException
```
    Copies the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in copy of unintended files.
    
    Parameters:
    
    src - directory to be copied
    
    dst - destination directory to be removed
    
    Throws:
    
    IOException - if unable to remove contents
  - copyDirectory
```
public static void copyDirectory(File src,
                                 File dst)
                          throws IOException
```
    Copies the specified directory path. Use with great caution since no attempt is made to check for symbolic links, which could result in copy of unintended files.
    
    Parameters:
    
    src - directory to be copied
    
    dst - destination directory to be removed
    
    Throws:
    
    IOException - if unable to remove contents

Class Tools

Method Summary

Methods inherited from class java.lang.Object

Method Detail

namedThreads

groupedThreads

minPriority

isNullOrEmpty

fromHex

toHex

toHex

get

delay

slurp

removeDirectory

removeDirectory

timeAgo

copyDirectory

copyDirectory