gov.nasa.jpf.util

Class JPFSiteUtils

java.lang.Object

gov.nasa.jpf.util.JPFSiteUtils

public class JPFSiteUtils
extends java.lang.Object

utility class for JPF site configuration related functions. This is partially redundant to Config since it is used during bootstrapping, and gov.nasa.jpf.Config might not be in the classpath yet. It mostly differs in terms of key/value expansion, which is only partially supported here. NOTE - this class is not allowed to use any JPF specific types

Constructor Summary

Constructors

Constructor and Description
JPFSiteUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	addProject(java.io.File siteProps, java.lang.String projectId, java.io.File projectDir, boolean isExt)
static java.io.File	getCoreDir(java.io.File siteProps)
static java.lang.String	getCurrentProjectId() look for a " = ${config_path}" entry in current dir/jpf.properties this looks recursively upwards
static java.io.File	getCurrentProjectProperties() find project properties (jpf.properties) from current dir
static java.util.List<java.lang.String>	getExtensions(java.util.List<Pair<java.lang.String,java.lang.String>> entries) this returns a list of all the project ids in the 'extensions' entries (also handles accumulated 'extensions+=.." entries
static java.lang.String	getGlobalSitePropertiesPath()
static java.lang.String	getMatchFromFile(java.lang.String pathName, java.lang.String lookupKey) minimal parsing - only local key, system property and and config_path expansion NOTE this stops after finding the key, and it doesn't add the file to the 'sources'
static java.util.List<Pair<java.lang.String,java.lang.String>>	getRawEntries(java.io.File siteProps)
static java.util.List<Pair<java.lang.String,java.lang.String>>	getRawEntries(java.io.Reader reader) this returns the contents of a config source in-order, without expanding values or keys
static java.io.File	getSiteCoreDir() get location of jpf-core from site.properties
static java.io.File	getSiteCoreDir(java.lang.String[] args)
static java.io.File	getSiteProperties(java.lang.String[] args)
static java.io.File	getStandardSiteProperties() locate the site.properties.
static boolean	isFreeArg(java.lang.String a)

Methods inherited from class java.lang.Object

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

Constructor Detail

JPFSiteUtils

public JPFSiteUtils()

Method Detail

getMatchFromFile

public static java.lang.String getMatchFromFile(java.lang.String pathName,
                                                java.lang.String lookupKey)

minimal parsing - only local key, system property and and config_path expansion NOTE this stops after finding the key, and it doesn't add the file to the 'sources'

getRawEntries

public static java.util.List<Pair<java.lang.String,java.lang.String>> getRawEntries(java.io.Reader reader)
                                                                             throws java.io.IOException

this returns the contents of a config source in-order, without expanding values or keys

Throws:

java.io.IOException

getCoreDir

public static java.io.File getCoreDir(java.io.File siteProps)

getSiteCoreDir

public static java.io.File getSiteCoreDir(java.lang.String[] args)

getSiteCoreDir

public static java.io.File getSiteCoreDir()

get location of jpf-core from site.properties

Returns:

null if it doesn't exist

getCurrentProjectProperties

public static java.io.File getCurrentProjectProperties()

find project properties (jpf.properties) from current dir

getCurrentProjectId

public static java.lang.String getCurrentProjectId()

look for a " = ${config_path}" entry in current dir/jpf.properties this looks recursively upwards

Returns:

null if no jpf.properties found

isFreeArg

public static boolean isFreeArg(java.lang.String a)

getSiteProperties

public static java.io.File getSiteProperties(java.lang.String[] args)

getStandardSiteProperties

public static java.io.File getStandardSiteProperties()

locate the site.properties. Start with the current dir, go upwards until the user.home is reached. If site.properties isn't found there, look for '.jpf' and 'jpf' dirs within the home dir. If no site.properties is found there either, give up

getGlobalSitePropertiesPath

public static java.lang.String getGlobalSitePropertiesPath()

getRawEntries

public static java.util.List<Pair<java.lang.String,java.lang.String>> getRawEntries(java.io.File siteProps)

getExtensions

public static java.util.List<java.lang.String> getExtensions(java.util.List<Pair<java.lang.String,java.lang.String>> entries)

this returns a list of all the project ids in the 'extensions' entries (also handles accumulated 'extensions+=.." entries

addProject

public static boolean addProject(java.io.File siteProps,
                                 java.lang.String projectId,
                                 java.io.File projectDir,
                                 boolean isExt)