java.lang.Object
- org.hl7.fhir.utilities.Utilities

```
public class Utilities
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Utilities.DecimalStatus

static interface Utilities.FileVisitor

Field Summary

Fields
Modifier and Type Field Description

static String BT

static String GB

static String KB

static String MB

static int ONE_MB

Constructor Summary

Constructors
Constructor Description

Utilities()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`analyseStringDiffs(Set<String> source, Set<String> target, Set<String> missed, Set<String> extra)`
`static String`	`appendDerivedTextToBase(String baseText, String derivedText)`	Appends a text from a derived element to its base element.
`static String`	`appendForwardSlash(String definitions)`
`static String`	`appendPeriod(String s)`
`static String`	`appendSlash(String definitions)`
`static String`	`asCSV(List<String> strings)`
`static String`	`asHtmlBr(String prefix, List<String> strings)`
`static void`	`bytesToFile(byte[] content, String filename)`
`static String`	`camelCase(String value)`
`static String`	`capitalize(String s)`
`static String`	`changeFileExt(String name, String ext)`
`static int`	`charCount(String s, char c)`
`static boolean`	`charInRange(char ch, char a, char z)`
`static boolean`	`charInSet(char value, char... array)`
`static Utilities.DecimalStatus`	`checkDecimal(String value, boolean allowExponent, boolean allowLeadingZero)`
`static boolean`	`checkFile(String purpose, String dir, String file, List<String> errors)`
`static boolean`	`checkFolder(String dir, List<String> errors)`
`static String`	`cleanFileName(String badFileName)`
`static String`	`cleanupTextString(String contents)`
`static void`	`clearDirectory(String folder, String... exemptions)`
`static boolean`	`compareIgnoreWhitespace(File f1, File f2)`
`static boolean`	`compareIgnoreWhitespace(String fn1, String fn2)`
`static void`	`copyDirectory(String sourceFolder, String destFolder, FileNotifier notifier)`
`static void`	`copyDirectory2(String sourceFolder, String destFolder, FileNotifier.FileNotifier2 notifier)`
`static void`	`copyFile(File sourceFile, File destFile)`
`static void`	`copyFile(String source, String dest)`
`static void`	`copyFileToDirectory(File source, File destDir)`
`static int`	`countFilesInDirectory(String dirName)`
`static File`	`createDirectory(String path)`
`static File`	`createTempFile(String prefix, String suffix)`
`static void`	`deleteAllFiles(String folder, String type)`
`static void`	`deleteEmptyFolders(File df)`
`static void`	`deleteTempFiles()`
`static String`	`describeDuration(Duration d)`
`static String`	`describeSize(int length)`
`static String`	`describeSize(long length)`
`static String`	`encodeUri(String v)`
`static boolean`	`endsWithInList(String s, String... list)`
`static boolean`	`endsWithInList(String s, Collection<String> list)`
`static boolean`	`equals(String one, String two)`
`static boolean`	`equivalent(String l, String r)`
`static boolean`	`equivalentNumber(String l, String r)`
`static String`	`escapeJava(String doco)`
`static String`	`escapeJson(String value)`
`static String`	`escapeXml(String doco)`
`static boolean`	`existsInList(int value, int... array)`
`static boolean`	`existsInList(String value, String... array)`
`static boolean`	`existsInList(String value, List<String> array)`
`static boolean`	`existsInListNC(String value, String... array)`
`static String`	`extractBaseUrl(String url)`
`static String`	`fhirPathToXPath(String path)`	Only handles simple FHIRPath expressions of the type produced by the validator
`static String`	`fileTitle(String file)`
`static int`	`findinList(String[] list, String val)`
`static Integer`	`getDatePrecision(String value)`
`static Integer`	`getDecimalPrecision(String value)`
`static String`	`getDirectoryForFile(String filepath)`
`static String`	`getFileExtension(String fn)`
`static String`	`getFileNameForName(String name)`
`static String`	`getRelativePath(String root, String path)`
`static Integer`	`getTimePrecision(String value)`
`static String`	`highBoundaryForDate(String value, int precision)`
`static String`	`highBoundaryForDecimal(String value, int precision)`
`static String`	`highBoundaryForTime(String value, int precision)`
`static String`	`humanize(String code)`
`static boolean`	`isAbsoluteFileName(String source)`
`static boolean`	`isAbsoluteUrl(String ref)`
`static boolean`	`isAbsoluteUrlLinkable(String ref)`
`static boolean`	`isAlphabetic(char c)`
`static boolean`	`isAsciiChar(char ch)`
`static boolean`	`isDecimal(String value, boolean allowExponent)`
`static boolean`	`isDecimal(String value, boolean allowExponent, boolean allowLeadingZero)`
`static boolean`	`isDigit(char c)`
`static boolean`	`isHex(String string)`
`static boolean`	`isInteger(String string)`
`static boolean`	`isLong(String string)`
`static boolean`	`isOid(String cc)`
`static boolean`	`isPlural(String word)`
`static boolean`	`isToken(String tail)`
`static boolean`	`isTokenChar(char ch)`
`static boolean`	`isURL(String s)`
`static boolean`	`isValidId(String id)`
`static boolean`	`isValidOID(String oid)`
`static boolean`	`isValidUUID(String uuid)`
`static boolean`	`isWhitespace(String s)`
`static boolean`	`isWindows()`
`static List<String>`	`listAllFiles(String path, List<String> ignoreList)`
`static String`	`listCanonicalUrls(Set<String> keys)`
`static String`	`lowBoundaryForDate(String value, int precision)`
`static String`	`lowBoundaryForDecimal(String value, int precision)`
`static String`	`lowBoundaryForTime(String value, int precision)`
`static String`	`makeId(String name)`
`static Object`	`makeSingleLine(String text)`
`static String`	`makeUuidLC()`
`static String`	`makeUuidUrn()`
`static String`	`nmtokenize(String cs)`
`static String`	`normaliseEolns(String value)`
`static String`	`normalize(String s)`
`static String`	`normalizeSameCase(String s)`
`static boolean`	`noString(String v)`
`static String`	`oidRoot(String id)`
`static String`	`oidTail(String id)`
`static String`	`padInt(int i, int len)`
`static String`	`padInt(long i, int len)`
`static String`	`padLeft(String src, char c, int len)`
`static String`	`padRight(String src, char c, int len)`
`static int`	`parseInt(String value, int def)`
`static String`	`path(String... args)`
`static String`	`pathURL(String... args)`
`static String`	`pluralize(String word, int count)`
`static String`	`pluralizeMe(String word)`	Returns the plural form of the word in the string.
`static String`	`removePeriod(String s)`
`static List<String>`	`sorted(Set<String> set)`
`static String[]`	`splitByCamelCase(String name)`
`static List<byte[]>`	`splitBytes(byte[] array, byte[] delimiter)`
`static String`	`splitLineForLength(String line, int prefixLength, int indent, int allowedLength)`
`static boolean`	`startsWithInList(String s, String... list)`
`static boolean`	`startsWithInList(String s, Collection<String> list)`
`static String`	`stringJoin(String sep, String... array)`
`static String`	`stripBOM(String string)`
`static String`	`systemEol()`
`static String`	`titleize(String s)`
`static String`	`toString(String[] expected)`
`static String`	`unCamelCase(String name)`
`static String`	`uncapitalize(String s)`
`static String`	`unescapeJson(String json)`
`static String`	`unescapeXml(String xml)`
`static void`	`unzip(InputStream zip, String target)`
`static void`	`unzip(InputStream zip, Path target)`
`static String`	`upperCamelCase(String value)`
`static String`	`URLDecode(String ref)`
`static String`	`URLEncode(String string)`
`static void`	`visitFiles(File folder, String extension, Utilities.FileVisitor visitor)`
`static void`	`visitFiles(String folder, String extension, Utilities.FileVisitor visitor)`
`static Path`	`zipSlipProtect(ZipEntry zipEntry, Path targetDir)`

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

Field Detail
- ONE_MB
```
public static final int ONE_MB
```
  See Also:
  
  Constant Field Values
- GB
```
public static final String GB
```
  See Also:
  
  Constant Field Values
- MB
```
public static final String MB
```
  See Also:
  
  Constant Field Values
- KB
```
public static final String KB
```
  See Also:
  
  Constant Field Values
- BT
```
public static final String BT
```
  See Also:
  
  Constant Field Values

Constructor Detail
- Utilities
```
public Utilities()
```

Method Detail

pluralizeMe

public static String pluralizeMe(String word)

Returns the plural form of the word in the string.

Examples:

   inflector.pluralize("post")               #=> "posts"
   inflector.pluralize("octopus")            #=> "octopi"
   inflector.pluralize("sheep")              #=> "sheep"
   inflector.pluralize("words")              #=> "words"
   inflector.pluralize("the blue mailman")   #=> "the blue mailmen"
   inflector.pluralize("CamelOctopus")       #=> "CamelOctopi"

Note that if the Object.toString() is called on the supplied object, so this method works for non-strings, too.

Parameters:: word - the word that is to be pluralized.
Returns:: the pluralized form of the word, or the word itself if it could not be pluralized
See Also:: Inflector.singularize(Object)

pluralize

public static String pluralize(String word,
                               int count)

isInteger

public static boolean isInteger(String string)

isLong

public static boolean isLong(String string)

isHex

public static boolean isHex(String string)

isDecimal

public static boolean isDecimal(String value,
                                boolean allowExponent,
                                boolean allowLeadingZero)

isDecimal

public static boolean isDecimal(String value,
                                boolean allowExponent)

checkDecimal

public static Utilities.DecimalStatus checkDecimal(String value,
                                                   boolean allowExponent,
                                                   boolean allowLeadingZero)

camelCase

public static String camelCase(String value)

upperCamelCase

public static String upperCamelCase(String value)

escapeXml

public static String escapeXml(String doco)

titleize

public static String titleize(String s)

capitalize

public static String capitalize(String s)

copyDirectory

public static void copyDirectory(String sourceFolder,
                                 String destFolder,
                                 FileNotifier notifier)
                          throws IOException,
                                 FHIRException

Throws:: IOException; FHIRException

copyDirectory2

public static void copyDirectory2(String sourceFolder,
                                  String destFolder,
                                  FileNotifier.FileNotifier2 notifier)
                           throws IOException,
                                  FHIRException

Throws:: IOException; FHIRException

copyFile

public static void copyFile(String source,
                            String dest)
                     throws IOException

Throws:: IOException

copyFile

public static void copyFile(File sourceFile,
                            File destFile)
                     throws IOException

Throws:: IOException

checkFolder

public static boolean checkFolder(String dir,
                                  List<String> errors)
                           throws IOException

Throws:: IOException

checkFile

public static boolean checkFile(String purpose,
                                String dir,
                                String file,
                                List<String> errors)
                         throws IOException

Throws:: IOException

asCSV

public static String asCSV(List<String> strings)

asHtmlBr

public static String asHtmlBr(String prefix,
                              List<String> strings)

clearDirectory

public static void clearDirectory(String folder,
                                  String... exemptions)
                           throws IOException

Throws:: IOException

createDirectory

public static File createDirectory(String path)
                            throws IOException

Throws:: IOException

changeFileExt

public static String changeFileExt(String name,
                                   String ext)

cleanupTextString

public static String cleanupTextString(String contents)

noString

public static boolean noString(String v)

bytesToFile

public static void bytesToFile(byte[] content,
                               String filename)
                        throws IOException

Throws:: IOException

appendSlash

public static String appendSlash(String definitions)

appendForwardSlash

public static String appendForwardSlash(String definitions)

fileTitle

public static String fileTitle(String file)

systemEol
```
public static String systemEol()
```

normaliseEolns

public static String normaliseEolns(String value)

unescapeXml

public static String unescapeXml(String xml)
                          throws FHIRException

Throws:: FHIRException

unescapeJson

public static String unescapeJson(String json)
                           throws FHIRException

Throws:: FHIRException

isPlural

public static boolean isPlural(String word)

padRight

public static String padRight(String src,
                              char c,
                              int len)

padLeft

public static String padLeft(String src,
                             char c,
                             int len)

path

public static String path(String... args)
                   throws IOException

Throws:: IOException

pathURL

public static String pathURL(String... args)

nmtokenize

public static String nmtokenize(String cs)

isToken

public static boolean isToken(String tail)

isTokenChar

public static boolean isTokenChar(char ch)

isDigit

public static boolean isDigit(char c)

isAlphabetic

public static boolean isAlphabetic(char c)

getDirectoryForFile

public static String getDirectoryForFile(String filepath)

appendPeriod

public static String appendPeriod(String s)

removePeriod

public static String removePeriod(String s)

stripBOM

public static String stripBOM(String string)

oidTail

public static String oidTail(String id)

oidRoot

public static String oidRoot(String id)

escapeJava

public static String escapeJava(String doco)

splitByCamelCase

public static String[] splitByCamelCase(String name)

encodeUri

public static String encodeUri(String v)

normalize

public static String normalize(String s)

normalizeSameCase

public static String normalizeSameCase(String s)

copyFileToDirectory

public static void copyFileToDirectory(File source,
                                       File destDir)
                                throws IOException

Throws:: IOException

isWhitespace

public static boolean isWhitespace(String s)

URLEncode

public static String URLEncode(String string)

URLDecode

public static String URLDecode(String ref)

charInSet

public static boolean charInSet(char value,
                                char... array)

charInRange

public static boolean charInRange(char ch,
                                  char a,
                                  char z)

existsInList

public static boolean existsInList(String value,
                                   List<String> array)

existsInList

public static boolean existsInList(String value,
                                   String... array)

existsInList

public static boolean existsInList(int value,
                                   int... array)

existsInListNC

public static boolean existsInListNC(String value,
                                     String... array)

stringJoin

public static String stringJoin(String sep,
                                String... array)

getFileNameForName

public static String getFileNameForName(String name)

deleteTempFiles

public static void deleteTempFiles()
                            throws IOException

Throws:: IOException

createTempFile

public static File createTempFile(String prefix,
                                  String suffix)
                           throws IOException

Throws:: IOException

isAsciiChar

public static boolean isAsciiChar(char ch)

makeUuidLC
```
public static String makeUuidLC()
```

makeUuidUrn
```
public static String makeUuidUrn()
```

isURL

public static boolean isURL(String s)

escapeJson

public static String escapeJson(String value)

humanize

public static String humanize(String code)

uncapitalize

public static String uncapitalize(String s)

charCount

public static int charCount(String s,
                            char c)

isOid

public static boolean isOid(String cc)

equals

public static boolean equals(String one,
                             String two)

deleteAllFiles

public static void deleteAllFiles(String folder,
                                  String type)

compareIgnoreWhitespace

public static boolean compareIgnoreWhitespace(File f1,
                                              File f2)
                                       throws IOException

Throws:: IOException

compareIgnoreWhitespace

public static boolean compareIgnoreWhitespace(String fn1,
                                              String fn2)
                                       throws IOException

Throws:: IOException

isAbsoluteUrl

public static boolean isAbsoluteUrl(String ref)

isAbsoluteUrlLinkable

public static boolean isAbsoluteUrlLinkable(String ref)

equivalent

public static boolean equivalent(String l,
                                 String r)

equivalentNumber

public static boolean equivalentNumber(String l,
                                       String r)

getFileExtension

public static String getFileExtension(String fn)

unCamelCase

public static String unCamelCase(String name)

isAbsoluteFileName

public static boolean isAbsoluteFileName(String source)

isWindows
```
public static boolean isWindows()
```

splitLineForLength

public static String splitLineForLength(String line,
                                        int prefixLength,
                                        int indent,
                                        int allowedLength)

countFilesInDirectory

public static int countFilesInDirectory(String dirName)

makeId

public static String makeId(String name)

visitFiles

public static void visitFiles(String folder,
                              String extension,
                              Utilities.FileVisitor visitor)
                       throws FileNotFoundException,
                              IOException

Throws:: FileNotFoundException; IOException

visitFiles

public static void visitFiles(File folder,
                              String extension,
                              Utilities.FileVisitor visitor)
                       throws FileNotFoundException,
                              IOException

Throws:: FileNotFoundException; IOException

extractBaseUrl

public static String extractBaseUrl(String url)

listCanonicalUrls

public static String listCanonicalUrls(Set<String> keys)

isValidId

public static boolean isValidId(String id)

sorted

public static List<String> sorted(Set<String> set)

analyseStringDiffs

public static void analyseStringDiffs(Set<String> source,
                                      Set<String> target,
                                      Set<String> missed,
                                      Set<String> extra)

fhirPathToXPath
```
public static String fhirPathToXPath(String path)
```
Only handles simple FHIRPath expressions of the type produced by the validator

Parameters:

path -

Returns:

describeDuration

public static String describeDuration(Duration d)

startsWithInList

public static boolean startsWithInList(String s,
                                       String... list)

startsWithInList

public static boolean startsWithInList(String s,
                                       Collection<String> list)

endsWithInList

public static boolean endsWithInList(String s,
                                     String... list)

endsWithInList

public static boolean endsWithInList(String s,
                                     Collection<String> list)

describeSize

public static String describeSize(int length)

describeSize

public static String describeSize(long length)

splitBytes

public static List<byte[]> splitBytes(byte[] array,
                                      byte[] delimiter)

unzip

public static void unzip(InputStream zip,
                         String target)
                  throws IOException

Throws:: IOException

unzip

public static void unzip(InputStream zip,
                         Path target)
                  throws IOException

Throws:: IOException

zipSlipProtect

public static Path zipSlipProtect(ZipEntry zipEntry,
                                  Path targetDir)
                           throws IOException

Throws:: IOException

cleanFileName

public static String cleanFileName(String badFileName)

isValidUUID

public static boolean isValidUUID(String uuid)

isValidOID

public static boolean isValidOID(String oid)

findinList

public static int findinList(String[] list,
                             String val)

toString

public static String toString(String[] expected)

lowBoundaryForDecimal

public static String lowBoundaryForDecimal(String value,
                                           int precision)

lowBoundaryForDate

public static String lowBoundaryForDate(String value,
                                        int precision)

lowBoundaryForTime

public static String lowBoundaryForTime(String value,
                                        int precision)

highBoundaryForTime

public static String highBoundaryForTime(String value,
                                         int precision)

highBoundaryForDecimal

public static String highBoundaryForDecimal(String value,
                                            int precision)

highBoundaryForDate

public static String highBoundaryForDate(String value,
                                         int precision)

getDecimalPrecision

public static Integer getDecimalPrecision(String value)

getDatePrecision

public static Integer getDatePrecision(String value)

getTimePrecision

public static Integer getTimePrecision(String value)

padInt

public static String padInt(int i,
                            int len)

padInt

public static String padInt(long i,
                            int len)

makeSingleLine

public static Object makeSingleLine(String text)

parseInt

public static int parseInt(String value,
                           int def)

appendDerivedTextToBase

public static String appendDerivedTextToBase(@Nullable
                                             String baseText,
                                             String derivedText)

Appends a text from a derived element to its base element.

Parameters:: baseText - The text set in the base element, or null.; derivedText - The text set in the derived element, starting with "...".
Returns:: The resulting text.

deleteEmptyFolders

public static void deleteEmptyFolders(File df)

getRelativePath

public static String getRelativePath(String root,
                                     String path)

listAllFiles

public static List<String> listAllFiles(String path,
                                        List<String> ignoreList)

Modifier and Type	Class	Description
`static class`	`Utilities.DecimalStatus`
`static interface`	`Utilities.FileVisitor`

Modifier and Type	Field	Description
`static String`	`BT`
`static String`	`GB`
`static String`	`KB`
`static String`	`MB`
`static int`	`ONE_MB`

Class Utilities

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_MB

GB

MB

KB

BT

Constructor Detail

Utilities

Method Detail

pluralizeMe

pluralize

isInteger

isLong

isHex

isDecimal

isDecimal

checkDecimal

camelCase

upperCamelCase

escapeXml

titleize

capitalize

copyDirectory

copyDirectory2

copyFile

copyFile

checkFolder

checkFile

asCSV

asHtmlBr

clearDirectory

createDirectory

changeFileExt

cleanupTextString

noString

bytesToFile

appendSlash

appendForwardSlash

fileTitle

systemEol

normaliseEolns

unescapeXml

unescapeJson

isPlural

padRight

padLeft

path

pathURL

nmtokenize

isToken

isTokenChar

isDigit

isAlphabetic

getDirectoryForFile

appendPeriod

removePeriod

stripBOM

oidTail

oidRoot

escapeJava

splitByCamelCase

encodeUri

normalize

normalizeSameCase

copyFileToDirectory

isWhitespace

URLEncode

URLDecode

charInSet

charInRange

existsInList

existsInList

existsInList

existsInListNC