OpenmrsUtil (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.util.OpenmrsUtil

```
public class OpenmrsUtil
extends Object
```
Utility methods used in openmrs

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static <K,V> void`	`addToListMap(Map<K,List<V>> map, K key, V obj)`
`static <K,V> void`	`addToSetMap(Map<K,Set<V>> map, K key, V obj)` Allows easy manipulation of a Map<?
`static void`	`applyLogLevel(String logClass, String logLevel)` Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by `OpenmrsLoggingUtil.applyLogLevel(String, String)`
`static void`	`applyLogLevels()` Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by `OpenmrsLoggingUtil.applyLogLevels()`
`static void`	`closeStream(Closeable closableStream)` A null-safe and exception safe way to close an inputstream or an outputstream
`static boolean`	`collectionContains(Collection<?> objects, Object obj)` Loops over the collection to check to see if the given object is in that collection.
`static int`	`compare(Date d1, Date d2)` Compares two java.util.Date objects, but handles java.sql.Timestamp (which is not directly comparable to a date) by dropping its nanosecond value.
`static <E> Collection<Collection<E>>`	`compareLists(Collection<E> origList, Collection<E> newList)` Compares origList to newList returning map of differences
`static int`	`compareWithNullAsEarliest(Date d1, Date d2)` Compares two Date/Timestamp objects, treating null as the earliest possible date.
`static <E extends Comparable<E>> int`	`compareWithNullAsGreatest(E c1, E c2)`
`static int`	`compareWithNullAsLatest(Date d1, Date d2)` Compares two Date/Timestamp objects, treating null as the earliest possible date.
`static <E extends Comparable<E>> int`	`compareWithNullAsLowest(E c1, E c2)`
`static List<Concept>`	`conceptListHelper(String descriptor)`
`static Set<Concept>`	`conceptSetHelper(String descriptor)`
`static <T> boolean`	`containsAny(Collection<T> collection, Collection<T> elements)`
`static boolean`	`containsDigit(String test)`
`static boolean`	`containsOnlyDigits(String test)`
`static boolean`	`containsUpperAndLowerCase(String test)`
`static Integer`	`convertToInteger(Long longValue)` This method converts the given Long value to an Integer.
`static void`	`copyFile(InputStream inputStream, OutputStream outputStream)` Copy file from inputStream onto the outputStream inputStream is not closed in this method outputStream /is/ closed at completion of this method
`static boolean`	`deleteDirectory(File dir)` Recursively deletes files in the given `dir` folder
`static List<Concept>`	`delimitedStringToConceptList(String delimitedString, String delimiter)` Parses and loads a delimited list of concept ids or names
`static Map<String,Concept>`	`delimitedStringToConceptMap(String delimitedString, String delimiter)`
`static List<Integer>`	`delimitedStringToIntegerList(String delimitedString, String delimiter)`
`static Date`	`firstSecondOfDay(Date date)` Return a date that is the same day as the passed in date, but the hours and seconds are the earliest possible for that day.
`static boolean`	`folderContains(File folder, String filename)` Look for a file named `filename` in folder
`static Date`	`fromDateHelper(Date comparisonDate, Integer withinLastDays, Integer withinLastMonths, Integer untilDaysAgo, Integer untilMonthsAgo, Date sinceDate, Date untilDate)`
`static String`	`generateUid()` Creates a uid of length 20
`static String`	`generateUid(Integer size)` Creates a relatively acceptable unique string of the give size
`static String`	`getApplicationDataDirectory()` Returns the application data directory.
`static File`	`getApplicationDataDirectoryAsFile()`
`static Map<String,String>`	`getCorePrivileges()` These are the privileges that are required by OpenMRS.
`static Map<String,String>`	`getCoreRoles()` All roles returned by this method are inserted into the database if they do not exist already.
`static SimpleDateFormat`	`getDateFormat(Locale locale)` Get the current user's date format Will look similar to "mm-dd-yyyy".
`static SimpleDateFormat`	`getDateTimeFormat(Locale locale)` Get the current user's datetime format Will look similar to "mm-dd-yyyy hh:mm a".
`static Set<String>`	`getDeclaredFields(Class<?> clazz)` Get declared field names of a class
`static File`	`getDirectoryInApplicationDataDirectory(String folderName)` Find the given folderName in the application data directory.
`static byte[]`	`getFileAsBytes(File file)` Return a byte array representation of the given file
`static String`	`getFileAsString(File file)` Return a string representation of the given file
`static String`	`getFileMimeType(File file)` Get mime type of the given file
`static Date`	`getLastMomentOfDay(Date day)` Gets the date having the last millisecond of a given day.
`static MemoryAppender`	`getMemoryAppender()` Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by `OpenmrsLoggingUtil.getMemoryAppender()` instead
`static String`	`getMessage(String code, Object... args)` Utility method for getting the translation for the passed code
`static String`	`getOpenmrsLogLocation()` Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by `OpenmrsLoggingUtil.getOpenmrsLogLocation()`
`static String`	`getOpenMRSVersionInTestMode()` Gets OpenMRS version name under test mode.
`static File`	`getOutFile(File dir, Date date, User user)` Gets an out File object.
`static InputStream`	`getResourceInputStream(URL url)` Opens input stream for given resource.
`static Properties`	`getRuntimeProperties(String applicationName)` Finds and loads the runtime properties file for a specific OpenMRS application.
`static String`	`getRuntimePropertiesFileNameInTestMode()`
`static String`	`getRuntimePropertiesFilePathName(String applicationName)` Gets the full path and name of the runtime properties file.
`static SimpleDateFormat`	`getTimeFormat(Locale locale)` Get the current user's time format Will look similar to "hh:mm a".
`static boolean`	`isConceptInList(Concept concept, List<Concept> list)`
`static Boolean`	`isInAbsoluteNumericRange(Float value, ConceptNumeric concept)`
`static Boolean`	`isInCriticalNumericRange(Float value, ConceptNumeric concept)`
`static Boolean`	`isInNormalNumericRange(Float value, ConceptNumeric concept)`
`static boolean`	`isStringInArray(String str, String[] arr)`
`static boolean`	`isTestMode()` Checks whether the system is running in test mode
`static Boolean`	`isValidNumericValue(Float value, ConceptNumeric concept)`
`static boolean`	`isYesterday(Date date)` Checks if the passed in date's day of the year is the one that comes immediately before that of the current date
`static <E> String`	`join(Collection<E> c, String separator)` Deprecated. as of 2.2 use Java's `String.join(java.lang.CharSequence, java.lang.CharSequence...)` or Apache Commons StringUtils.join for iterables which do not extend `CharSequence`
`static void`	`loadProperties(Properties props, File propertyFile)` Convenience method used to load properties from the given file.
`static void`	`loadProperties(Properties props, InputStream inputStream)` This method is a replacement for Properties.load(InputStream) so that we can load in utf-8 characters.
`static <Arg1,Arg2 extends Arg1> boolean`	`nullSafeEquals(Arg1 d1, Arg2 d2)`
`static boolean`	`nullSafeEqualsIgnoreCase(String s1, String s2)` Performs a case insensitive Comparison of two strings taking care of null values
`static Object`	`parse(String string, Class clazz)` Takes a String (e.g. a user-entered one) and parses it into an object of the specified class
`static Map<String,String>`	`parseParameterList(String paramList)` Takes a String like "size=compact\|order=date" and returns a Map<String,String> from the keys to the values.
`static Date`	`safeDate(Date d1)`
`static void`	`saveDocument(Document doc, File outFile)` Save the given xml document to the given outfile
`static void`	`setApplicationDataDirectory(String path)` Can be used to override default application data directory.
`static void`	`setupLogAppenders()` Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by `OpenmrsLoggingUtil.reloadLoggingConfiguration()`
`static String`	`shortenedStackTrace(String stackTrace)` Convert a stack trace into a shortened version for easier viewing and data storage, excluding those lines we are least concerned with; should average about 60% reduction in stack trace length
`static void`	`startup(Properties p)` Initialize global settings Find and load modules
`static void`	`storeProperties(Properties properties, File file, String comment)` Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.
`static void`	`storeProperties(Properties properties, OutputStream outStream, String comment)` Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument.
`static boolean`	`stringStartsWith(String str, String[] prefixes)` Tests if the given String starts with any of the specified prefixes
`static Date`	`toDateHelper(Date comparisonDate, Integer withinLastDays, Integer withinLastMonths, Integer untilDaysAgo, Integer untilMonthsAgo, Date sinceDate, Date untilDate)`
`static File`	`url2file(URL url)` Utility method to convert local URL to a File object.
`static void`	`validateJavaVersion()` Checks whether the current JVM version is at least Java 8.
`static void`	`validatePassword(String username, String password, String systemId)` Utility to check the validity of a password for a certain `User`.

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

Method Detail

compareLists

public static <E> Collection<Collection<E>> compareLists(Collection<E> origList,
                                                         Collection<E> newList)

Compares origList to newList returning map of differences

Parameters:: origList -; newList -
Returns:: [List toAdd, List toDelete] with respect to origList

isStringInArray

public static boolean isStringInArray(String str,
                                      String[] arr)

isInNormalNumericRange

public static Boolean isInNormalNumericRange(Float value,
                                             ConceptNumeric concept)

isInCriticalNumericRange

public static Boolean isInCriticalNumericRange(Float value,
                                               ConceptNumeric concept)

isInAbsoluteNumericRange

public static Boolean isInAbsoluteNumericRange(Float value,
                                               ConceptNumeric concept)

isValidNumericValue

public static Boolean isValidNumericValue(Float value,
                                          ConceptNumeric concept)

getFileAsString
```
public static String getFileAsString(File file)
                              throws IOException
```
Return a string representation of the given file

Parameters:

file -

Returns:

String file contents

Throws:

IOException

getFileAsBytes
```
public static byte[] getFileAsBytes(File file)
                             throws IOException
```
Return a byte array representation of the given file

Parameters:

file -

Returns:

byte[] file contents

Throws:

IOException

copyFile
```
public static void copyFile(InputStream inputStream,
                            OutputStream outputStream)
                     throws IOException
```
Copy file from inputStream onto the outputStream inputStream is not closed in this method outputStream /is/ closed at completion of this method

Parameters:

inputStream - Stream to copy from

outputStream - Stream/location to copy to

Throws:

IOException - thrown if an error occurs during read/write Should not copy the outputstream if outputstream is null Should not copy the outputstream if inputstream is null Should copy inputstream to outputstream and close the outputstream

getFileMimeType
```
public static String getFileMimeType(File file)
```
Get mime type of the given file

Parameters:

file -

Returns:

mime type

folderContains

public static boolean folderContains(File folder,
                                     String filename)

Look for a file named filename in folder

Parameters:: folder -; filename -
Returns:: true/false whether filename exists in folder

getCorePrivileges
```
public static Map<String,String> getCorePrivileges()
```
These are the privileges that are required by OpenMRS. This looks for privileges marked as AddOnStartup to know which privs, upon startup or loading of a module, to insert into the database if they do not exist already. These privileges are not allowed to be deleted. They are marked as 'locked' in the administration screens.

Returns:

privileges core to the system

See Also:

PrivilegeConstants, Context.checkCoreDataset()

getCoreRoles
```
public static Map<String,String> getCoreRoles()
```
All roles returned by this method are inserted into the database if they do not exist already. These roles are also forbidden to be deleted from the administration screens.

Returns:

roles that are core to the system

startup
```
public static void startup(Properties p)
```
Initialize global settings Find and load modules

Parameters:

p - properties from runtime configuration

getMemoryAppender
```
@Deprecated
public static MemoryAppender getMemoryAppender()
```
Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.getMemoryAppender() instead

Gets the in-memory log appender. This method needed to be added as it is much more difficult to get a specific appender in the Log4J2 architecture. This method is called in places where we need to display logging message.

Since:

2.4.0

applyLogLevels
```
@Logging(ignore=true)
 @Deprecated
public static void applyLogLevels()
```
Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.applyLogLevels()

Set the org.openmrs log4j logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists. Valid values for global property are trace, debug, info, warn, error or fatal.

setupLogAppenders
```
@Deprecated
public static void setupLogAppenders()
```
Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.reloadLoggingConfiguration()

Setup root level log appenders.

Since:

1.9.2

applyLogLevel
```
@Deprecated
public static void applyLogLevel(String logClass,
                                             String logLevel)
```
Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.applyLogLevel(String, String)

Set the log4j log level for class logClass to logLevel.

Parameters:

logClass - optional string giving the class level to change. Defaults to OpenmrsConstants.LOG_CLASS_DEFAULT . Should be something like org.openmrs.___

logLevel - one of OpenmrsConstants.LOG_LEVEL_*

parseParameterList
```
public static Map<String,String> parseParameterList(String paramList)
```
Takes a String like "size=compact|order=date" and returns a Map<String,String> from the keys to the values.

Parameters:

paramList - String with a list of parameters

Returns:

Map<String, String> of the parameters passed

nullSafeEquals

public static <Arg1,Arg2 extends Arg1> boolean nullSafeEquals(Arg1 d1,
                                                              Arg2 d2)

compare
```
public static int compare(Date d1,
                          Date d2)
```
Compares two java.util.Date objects, but handles java.sql.Timestamp (which is not directly comparable to a date) by dropping its nanosecond value.

compareWithNullAsEarliest

public static int compareWithNullAsEarliest(Date d1,
                                            Date d2)

Compares two Date/Timestamp objects, treating null as the earliest possible date.

compareWithNullAsLatest

public static int compareWithNullAsLatest(Date d1,
                                          Date d2)

Compares two Date/Timestamp objects, treating null as the earliest possible date.

compareWithNullAsLowest

public static <E extends Comparable<E>> int compareWithNullAsLowest(E c1,
                                                                    E c2)

compareWithNullAsGreatest

public static <E extends Comparable<E>> int compareWithNullAsGreatest(E c1,
                                                                      E c2)

join
```
@Deprecated
public static <E> String join(Collection<E> c,
                                          String separator)
```
Deprecated. as of 2.2 use Java's String.join(java.lang.CharSequence, java.lang.CharSequence...) or Apache Commons StringUtils.join for iterables which do not extend CharSequence

Converts a collection to a String with a specified separator between all elements

Parameters:

c - Collection to be joined

separator - string to put between all elements

Returns:

a String representing the toString() of all elements in c, separated by separator

conceptSetHelper

public static Set<Concept> conceptSetHelper(String descriptor)

delimitedStringToConceptList
```
public static List<Concept> delimitedStringToConceptList(String delimitedString,
                                                         String delimiter)
```
Parses and loads a delimited list of concept ids or names

Parameters:

delimitedString - the delimited list of concept ids or names

delimiter - the delimiter, e.g. ","

Returns:

the list of concepts

Since:

1.10, 1.9.2, 1.8.5

delimitedStringToConceptMap

public static Map<String,Concept> delimitedStringToConceptMap(String delimitedString,
                                                              String delimiter)

conceptListHelper

public static List<Concept> conceptListHelper(String descriptor)

getLastMomentOfDay
```
public static Date getLastMomentOfDay(Date day)
```
Gets the date having the last millisecond of a given day. Meaning that the hours, seconds, and milliseconds are the latest possible for that day.

Parameters:

day - the day.

Returns:

the date with the last millisecond of the day.

firstSecondOfDay
```
public static Date firstSecondOfDay(Date date)
```
Return a date that is the same day as the passed in date, but the hours and seconds are the earliest possible for that day.

Parameters:

date - date to adjust

Returns:

a date that is the first possible time in the day

Since:

1.9

safeDate
```
public static Date safeDate(Date d1)
```

deleteDirectory
```
public static boolean deleteDirectory(File dir)
                               throws IOException
```
Recursively deletes files in the given dir folder

Parameters:

dir - File directory to delete

Returns:

true/false whether the delete was completed successfully

Throws:

IOException - if dir is not a directory

url2file
```
public static File url2file(URL url)
```
Utility method to convert local URL to a File object.

Parameters:

url - an URL

Returns:

file object for given URL or null if URL is not local Should return null given null parameter

getResourceInputStream
```
public static InputStream getResourceInputStream(URL url)
                                          throws IOException
```
Opens input stream for given resource. This method behaves differently for different URL types:
- for local files it returns buffered file input stream;
- for local JAR files it reads resource content into memory buffer and returns byte array input stream that wraps those buffer (this prevents locking JAR file);
- for common URL's this method simply opens stream to that URL using standard URL API.
It is not recommended to use this method for big resources within JAR files.
Parameters:

url - resource URL

Returns:

input stream for given resource

Throws:

IOException - if any I/O error has occurred

getApplicationDataDirectory

public static String getApplicationDataDirectory()

 Returns the application data directory. Searches for the value first 
 in the "OPENMRS_APPLICATION_DATA_DIRECTORY" system property and "application_data_directory" runtime property, then in the servlet
 init parameter "application.data.directory." If not found, returns:
 a) "{user.home}/.OpenMRS" on UNIX-based systems
 b) "{user.home}\Application Data\OpenMRS" on Windows

Returns:: The path to the directory on the file system that will hold miscellaneous data about the application (runtime properties, modules, etc)

getApplicationDataDirectoryAsFile

public static File getApplicationDataDirectoryAsFile()

setApplicationDataDirectory
```
public static void setApplicationDataDirectory(String path)
```
Can be used to override default application data directory.
Note that it will not override application data directory provided as a system property.

Parameters:

path -

Since:

1.11

getOpenmrsLogLocation
```
@Deprecated
public static String getOpenmrsLogLocation()
```
Deprecated. As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.getOpenmrsLogLocation()

Returns the location of the OpenMRS log file.
Warning: as of 2.4.4, 2.5.1, and 2.6.0 which allows configuration via a configuration file, the result of this call can return null if either the file appender uses a name other than OpenmrsConstants.LOG_OPENMRS_FILE_APPENDER or if the appender with that name is not one of the default file appending types.

Returns:

the path to the OpenMRS log file

Since:

1.9.2

validateJavaVersion
```
public static void validateJavaVersion()
```
Checks whether the current JVM version is at least Java 8.

Throws:

APIException - if the current JVM version is earlier than Java 8

getDirectoryInApplicationDataDirectory
```
public static File getDirectoryInApplicationDataDirectory(String folderName)
                                                   throws APIException
```
Find the given folderName in the application data directory. Or, treat folderName like an absolute url to a directory

Parameters:

folderName -

Returns:

folder capable of storing information

Throws:

APIException

saveDocument
```
public static void saveDocument(Document doc,
                                File outFile)
```
Save the given xml document to the given outfile

Parameters:

doc - Document to be saved

outFile - file pointer to the location the xml file is to be saved to

delimitedStringToIntegerList

public static List<Integer> delimitedStringToIntegerList(String delimitedString,
                                                         String delimiter)

stringStartsWith
```
public static boolean stringStartsWith(String str,
                                       String[] prefixes)
```
Tests if the given String starts with any of the specified prefixes

Parameters:

str - the string to test

prefixes - an array of prefixes to test against

Returns:

true if the String starts with any of the specified prefixes, otherwise false.

isConceptInList

public static boolean isConceptInList(Concept concept,
                                      List<Concept> list)

fromDateHelper

public static Date fromDateHelper(Date comparisonDate,
                                  Integer withinLastDays,
                                  Integer withinLastMonths,
                                  Integer untilDaysAgo,
                                  Integer untilMonthsAgo,
                                  Date sinceDate,
                                  Date untilDate)

toDateHelper

public static Date toDateHelper(Date comparisonDate,
                                Integer withinLastDays,
                                Integer withinLastMonths,
                                Integer untilDaysAgo,
                                Integer untilMonthsAgo,
                                Date sinceDate,
                                Date untilDate)

containsAny

public static <T> boolean containsAny(Collection<T> collection,
                                      Collection<T> elements)

Parameters:: collection -; elements -
Returns:: Whether _collection_ contains any of _elements_

addToSetMap

public static <K,V> void addToSetMap(Map<K,Set<V>> map,
                                     K key,
                                     V obj)

Allows easy manipulation of a Map<?, Set>

addToListMap

public static <K,V> void addToListMap(Map<K,List<V>> map,
                                      K key,
                                      V obj)

getDateFormat
```
public static SimpleDateFormat getDateFormat(Locale locale)
```
Get the current user's date format Will look similar to "mm-dd-yyyy". Depends on user's locale.

Returns:

a simple date format Should return a pattern with four y characters in it Should not allow the returned SimpleDateFormat to be modified

Since:

1.5

getTimeFormat
```
public static SimpleDateFormat getTimeFormat(Locale locale)
```
Get the current user's time format Will look similar to "hh:mm a". Depends on user's locale.

Returns:

a simple time format Should return a pattern with two h characters in it Should not allow the returned SimpleDateFormat to be modified

Since:

1.9

getDateTimeFormat
```
public static SimpleDateFormat getDateTimeFormat(Locale locale)
```
Get the current user's datetime format Will look similar to "mm-dd-yyyy hh:mm a". Depends on user's locale.

Returns:

a simple date format Should return a pattern with four y characters and two h characters in it Should not allow the returned SimpleDateFormat to be modified

Since:

1.9

parse
```
public static Object parse(String string,
                           Class clazz)
```
Takes a String (e.g. a user-entered one) and parses it into an object of the specified class

Parameters:

string -

clazz -

Returns:

Object of type clazz with the data from string

collectionContains
```
public static boolean collectionContains(Collection<?> objects,
                                         Object obj)
```
Loops over the collection to check to see if the given object is in that collection. This method only uses the .equals() method for comparison. This should be used in the patient/person objects on their collections. Their collections are SortedSets which use the compareTo method for equality as well. The compareTo method is currently optimized for sorting, not for equality. A null obj will return false

Parameters:

objects - collection to loop over

obj - Object to look for in the objects

Returns:

true/false whether the given object is found Should use equals method for comparison instead of compareTo given List collection Should use equals method for comparison instead of compareTo given SortedSet collection

getOutFile
```
public static File getOutFile(File dir,
                              Date date,
                              User user)
```
Gets an out File object. If date is not provided, the current timestamp is used. If user is not provided, the user id is not put into the filename. Assumes dir is already created

Parameters:

dir - directory to make the random filename in

date - optional Date object used for the name

user - optional User creating this file object

Returns:

file new file that is able to be written to

generateUid
```
public static String generateUid(Integer size)
```
Creates a relatively acceptable unique string of the give size

Returns:

unique string

generateUid
```
public static String generateUid()
```
Creates a uid of length 20

See Also:

generateUid(Integer)

storeProperties
```
public static void storeProperties(Properties properties,
                                   File file,
                                   String comment)
```
Convenience method to replace Properties.store(), which isn't UTF-8 compliant
NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.

Parameters:

properties -

file -

comment -

storeProperties
```
public static void storeProperties(Properties properties,
                                   OutputStream outStream,
                                   String comment)
```
Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument.

Parameters:

properties -

outStream -

comment - (which appears in comments in properties file)

loadProperties
```
public static void loadProperties(Properties props,
                                  InputStream inputStream)
```
This method is a replacement for Properties.load(InputStream) so that we can load in utf-8 characters. Currently the load method expects the inputStream to point to a latin1 encoded file.
NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.

Parameters:

props - the properties object to write into

inputStream - the input stream to read from

loadProperties
```
public static void loadProperties(Properties props,
                                  File propertyFile)
```
Convenience method used to load properties from the given file.

Parameters:

props - the properties object to be loaded into

propertyFile - the properties file to read

getMessage
```
public static String getMessage(String code,
                                Object... args)
```
Utility method for getting the translation for the passed code

Parameters:

code - the message key to lookup

args - the replacement values for the translation string

Returns:

the message, or if not found, the code

validatePassword

public static void validatePassword(String username,
                                    String password,
                                    String systemId)
                             throws PasswordException

Utility to check the validity of a password for a certain User. Passwords must be non-null. Their required strength is configured via global properties:

Description	Property	Default Value
Require that it not match the `User`'s username or system id	`OpenmrsConstants.GP_PASSWORD_CANNOT_MATCH_USERNAME_OR_SYSTEMID`	true
Require a minimum length	`OpenmrsConstants.GP_PASSWORD_MINIMUM_LENGTH`	8
Require both an upper and lower case character	`OpenmrsConstants.GP_PASSWORD_REQUIRES_UPPER_AND_LOWER_CASE`	true
Require at least one numeric character	`OpenmrsConstants.GP_PASSWORD_REQUIRES_DIGIT`	true
Require at least one non-numeric character	`OpenmrsConstants.GP_PASSWORD_REQUIRES_NON_DIGIT`	true
Require a match on the specified regular expression	`OpenmrsConstants.GP_PASSWORD_CUSTOM_REGEX`	null

Parameters:: username - user name of the user with password to validated; password - string that will be validated; systemId - system id of the user with password to be validated
Throws:: PasswordException
Since:: 1.5 Should fail with short password by default Should fail with short password if not allowed Should pass with short password if allowed Should fail with digit only password by default Should fail with digit only password if not allowed Should pass with digit only password if allowed Should fail with char only password by default Should fail with char only password if not allowed Should pass with char only password if allowed Should fail without both upper and lower case password by default Should fail without both upper and lower case password if not allowed Should pass without both upper and lower case password if allowed Should fail with password equals to user name by default Should fail with password equals to user name if not allowed Should pass with password equals to user name if allowed Should fail with password equals to system id by default Should fail with password equals to system id if not allowed Should pass with password equals to system id if allowed Should fail with password not matching configured regex Should pass with password matching configured regex Should allow password to contain non alphanumeric characters Should allow password to contain white spaces Should still work without an open session

containsUpperAndLowerCase
```
public static boolean containsUpperAndLowerCase(String test)
```
Parameters:

test - the string to test

Returns:

true if the passed string contains both upper and lower case characters Should return true if string contains upper and lower case Should return false if string does not contain lower case characters Should return false if string does not contain upper case characters

containsOnlyDigits
```
public static boolean containsOnlyDigits(String test)
```
Parameters:

test - the string to test

Returns:

true if the passed string contains only numeric characters Should return true if string contains only digits Should return false if string contains any non-digits

containsDigit
```
public static boolean containsDigit(String test)
```
Parameters:

test - the string to test

Returns:

true if the passed string contains any numeric characters Should return true if string contains any digits Should return false if string contains no digits

closeStream
```
public static void closeStream(Closeable closableStream)
```
A null-safe and exception safe way to close an inputstream or an outputstream

Parameters:

closableStream - an InputStream or OutputStream to close

shortenedStackTrace
```
public static String shortenedStackTrace(String stackTrace)
```
Convert a stack trace into a shortened version for easier viewing and data storage, excluding those lines we are least concerned with; should average about 60% reduction in stack trace length

Parameters:

stackTrace - original stack trace from an error

Returns:

shortened stack trace Should return null if stackTrace is null Should remove springframework and reflection related lines

Since:

1.7

getRuntimeProperties

public static Properties getRuntimeProperties(String applicationName)

 Finds and loads the runtime properties file for a specific OpenMRS application.
 Searches for the file in this order:
 1) {current directory}/{applicationname}_runtime.properties
 2) an environment variable called "{APPLICATIONNAME}_RUNTIME_PROPERTIES_FILE"
 3) {openmrs_app_dir}/{applicationName}_runtime.properties   // openmrs_app_dir is typically {user_home}/.OpenMRS

Parameters:: applicationName - (defaults to "openmrs") the name of the running OpenMRS application, e.g. if you have deployed OpenMRS as a web application you would give the deployed context path here
Returns:: runtime properties, or null if none can be found
Since:: 1.8
See Also:: getApplicationDataDirectory()

isTestMode
```
public static boolean isTestMode()
```
Checks whether the system is running in test mode

Returns:

boolean

getRuntimePropertiesFilePathName
```
public static String getRuntimePropertiesFilePathName(String applicationName)
```
Gets the full path and name of the runtime properties file.

Parameters:

applicationName - (defaults to "openmrs") the name of the running OpenMRS application, e.g. if you have deployed OpenMRS as a web application you would give the deployed context path here

Returns:

runtime properties file path and name, or null if none can be found

Since:

1.9

getRuntimePropertiesFileNameInTestMode

public static String getRuntimePropertiesFileNameInTestMode()

getOpenMRSVersionInTestMode
```
public static String getOpenMRSVersionInTestMode()
```
Gets OpenMRS version name under test mode.

Returns:

String openmrs version number

nullSafeEqualsIgnoreCase
```
public static boolean nullSafeEqualsIgnoreCase(String s1,
                                               String s2)
```
Performs a case insensitive Comparison of two strings taking care of null values

Parameters:

s1 - the string to compare

s2 - the string to compare

Returns:

true if strings are equal (ignoring case) Should return false if only one of the strings is null Should be case insensitive

Since:

1.8

convertToInteger
```
public static Integer convertToInteger(Long longValue)
```
This method converts the given Long value to an Integer. If the Long value will not fit in an Integer an exception is thrown

Parameters:

longValue - the value to convert

Returns:

the long value in integer form.

Throws:

IllegalArgumentException - if the long value does not fit into an integer

isYesterday
```
public static boolean isYesterday(Date date)
```
Checks if the passed in date's day of the year is the one that comes immediately before that of the current date

Parameters:

date - the date to check

Returns:

true if the date comes immediately before the current date otherwise false

Since:

1.9

getDeclaredFields
```
public static Set<String> getDeclaredFields(Class<?> clazz)
```
Get declared field names of a class

Parameters:

clazz -

Returns:

Class OpenmrsUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareLists

isStringInArray

isInNormalNumericRange

isInCriticalNumericRange

isInAbsoluteNumericRange

isValidNumericValue

getFileAsString

getFileAsBytes

copyFile

getFileMimeType

folderContains

getCorePrivileges

getCoreRoles

startup

getMemoryAppender

applyLogLevels

setupLogAppenders

applyLogLevel

parseParameterList

nullSafeEquals

compare

compareWithNullAsEarliest

compareWithNullAsLatest

compareWithNullAsLowest

compareWithNullAsGreatest

join

conceptSetHelper

delimitedStringToConceptList

delimitedStringToConceptMap

conceptListHelper

getLastMomentOfDay

firstSecondOfDay

safeDate

deleteDirectory

url2file

getResourceInputStream

getApplicationDataDirectory

getApplicationDataDirectoryAsFile

setApplicationDataDirectory

getOpenmrsLogLocation

validateJavaVersion

getDirectoryInApplicationDataDirectory

saveDocument

delimitedStringToIntegerList

stringStartsWith

isConceptInList

fromDateHelper

toDateHelper

containsAny

addToSetMap

addToListMap

getDateFormat

getTimeFormat

getDateTimeFormat

parse

collectionContains

getOutFile

generateUid

generateUid

storeProperties

storeProperties

loadProperties

loadProperties

getMessage

validatePassword

containsUpperAndLowerCase

containsOnlyDigits

containsDigit

closeStream

shortenedStackTrace

getRuntimeProperties

isTestMode

getRuntimePropertiesFilePathName

getRuntimePropertiesFileNameInTestMode

getOpenMRSVersionInTestMode

nullSafeEqualsIgnoreCase