StringTools

Object
- com.xilinx.rapidwright.util.StringTools

```
public class StringTools
extends Object
```
A set of String utility methods. Created on: May 25, 2016

Field Summary

Fields
Modifier and Type Field and Description

static int COLUMN_SPACING
Number of spaces between column prints in StringTools.printListInColumns(List, PrintStream)

Fields
Modifier and Type	Field and Description
`static int`	`COLUMN_SPACING` Number of spaces between column prints in `StringTools.printListInColumns(List, PrintStream)`

Constructor Summary

Constructors
Constructor and Description

StringTools()

Constructors
Constructor and Description
`StringTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`addIndexingAngleBrackets(String s)` Will insert angle brackets around indexing value at the end of a String.
`static int`	`countOccurrences(String str, char c)` Counts occurrences of a character in a string.
`static String`	`getOptionValue(String option, String[] args)` Light-weight helper method to get the value of an option in an array of arguments.
`static boolean`	`isInteger(String s)`
`static String`	`longestCommonPrefix(String s0, String s1)` Get the longest common prefix between two strings starting at the beginning.
`static String`	`lowerCaseFirstLetter(String name)`
`static void`	`main(String[] args)`
`static String`	`makeCamelCase(String name)`
`static String`	`makeUpperCamelCase(String name)`
`static String`	`makeWhiteSpace(int length)` Creates a String of spaces of the specified length
`static List<String>`	`naturalSort(List<String> strings)` Sorts strings using the 'natural' sort approach where numbers are sorted by their magnitudes, i.e.
`static String[]`	`naturalSort(String[] strings)` Sorts strings using the 'natural' sort approach where numbers are sorted by their magnitudes, i.e.
`static void`	`printListInColumns(List<String> items, PrintStream ps)` Prints a list of Strings in columns, based upon the terminal width.
`static void`	`printListInColumns(List<String> items, PrintStream ps, int maxColumns)` Prints a list of Strings in columns, based upon the terminal width.
`static String`	`removeLastSeparator(String s)` Removes any trailing '/' (File.separator) characters from file paths.
`static String`	`removeOuterQuotes(String s)` Removes any double quote characters from the ends of the string.
`static String`	`startsWithAny(String str, Collection<String> prefixes)` Checks if given string starts with any of the provided prefix strings

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COLUMN_SPACING
```
public static final int COLUMN_SPACING
```
    Number of spaces between column prints in StringTools.printListInColumns(List, PrintStream)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StringTools
```
public StringTools()
```
- Method Detail
  - makeCamelCase
```
public static String makeCamelCase(String name)
```
  - lowerCaseFirstLetter
```
public static String lowerCaseFirstLetter(String name)
```
  - makeUpperCamelCase
```
public static String makeUpperCamelCase(String name)
```
  - removeOuterQuotes
```
public static String removeOuterQuotes(String s)
```
    Removes any double quote characters from the ends of the string.
    
    Parameters:
    
    s -
    
    Returns:
  - naturalSort
```
public static List<String> naturalSort(List<String> strings)
```
    Sorts strings using the 'natural' sort approach where numbers are sorted by their magnitudes, i.e. {1,2,3,4,5,6,7,8,9,10,...} as opposed to strict ASCII sorting {1,10,11,12,13, ...}
    
    Parameters:
    
    strings - The list of strings to sort
    
    Returns:
    
    The natural sorted list of strings.
  - removeLastSeparator
```
public static String removeLastSeparator(String s)
```
    Removes any trailing '/' (File.separator) characters from file paths. If none are present, the original string is returned.
    
    Parameters:
    
    s - File path
    
    Returns:
    
    The file path with File.separator removed or the original string if
  - naturalSort
```
public static String[] naturalSort(String[] strings)
```
    Sorts strings using the 'natural' sort approach where numbers are sorted by their magnitudes, i.e. {1,2,3,4,5,6,7,8,9,10,...} as opposed to strict ASCII sorting {1,10,11,12,13, ...}
    
    Parameters:
    
    strings - The array of strings to sort
    
    Returns:
    
    The natural sorted array of strings.
  - isInteger
```
public static boolean isInteger(String s)
```
  - addIndexingAngleBrackets
```
public static String addIndexingAngleBrackets(String s)
```
    Will insert angle brackets around indexing value at the end of a String. For example: input0 --> input<0> input10 --> input<10> clk --> clk
    
    Parameters:
    
    s - The string to which potentially angle brackets will be added
    
    Returns:
    
    The string with angle bracket around last integer or no change if no integer is found.
  - countOccurrences
```
public static int countOccurrences(String str,
                                   char c)
```
    Counts occurrences of a character in a string.
    
    Parameters:
    
    str - String to check
    
    c - Character of interest
    
    Returns:
    
    The number of occurrences in the the string
  - longestCommonPrefix
```
public static String longestCommonPrefix(String s0,
                                         String s1)
```
    Get the longest common prefix between two strings starting at the beginning.
    
    Parameters:
    
    s0 - First string to check
    
    s1 - Second string to check
    
    Returns:
    
    Longest common prefix string or empty string if none.
  - startsWithAny
```
public static String startsWithAny(String str,
                                   Collection<String> prefixes)
```
    Checks if given string starts with any of the provided prefix strings
    
    Parameters:
    
    str - The string to check
    
    prefixes - The set of possible prefixes to match against str
    
    Returns:
    
    A prefix that matches, although there could exist other matches that have a longer match. Returns null if no prefix match is found.
  - makeWhiteSpace
```
public static String makeWhiteSpace(int length)
```
    Creates a String of spaces of the specified length
    
    Parameters:
    
    length - The number of spaces in the desired String
    
    Returns:
    
    A String containing spaces of the desired length. Any length less than 1 will return a String of length 0.
  - printListInColumns
```
public static void printListInColumns(List<String> items,
                                      PrintStream ps)
```
    Prints a list of Strings in columns, based upon the terminal width.
    
    Parameters:
    
    items - The list of Strings to print
    
    ps - The stream to send the printed Strings to.
  - printListInColumns
```
public static void printListInColumns(List<String> items,
                                      PrintStream ps,
                                      int maxColumns)
```
    Prints a list of Strings in columns, based upon the terminal width.
    
    Parameters:
    
    items - The list of Strings to print
    
    ps - The stream to send the printed Strings to.
    
    maxColumns - A maximum limit to the number columns to print
  - getOptionValue
```
public static String getOptionValue(String option,
                                    String[] args)
```
    Light-weight helper method to get the value of an option in an array of arguments. For example, if option is '--option' and args is {"in.dcp", "out.dcp", "--option=value"}, this method will return 'value'.
    
    Parameters:
    
    option - The name of the option to search for
    
    args - The list or arguments (usually from main())
    
    Returns:
    
    The value of the option or null if it was not found
  - main
```
public static void main(String[] args)
```

Class StringTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

COLUMN_SPACING

Constructor Detail

StringTools

Method Detail

makeCamelCase

lowerCaseFirstLetter

makeUpperCamelCase

removeOuterQuotes

naturalSort

removeLastSeparator

naturalSort

isInteger

addIndexingAngleBrackets

countOccurrences

longestCommonPrefix

startsWithAny

makeWhiteSpace

printListInColumns

printListInColumns

getOptionValue

main