Package com.metsci.glimpse.topo.io

Class TopoDataPaths

java.lang.Object

com.metsci.glimpse.topo.io.TopoDataPaths

public class TopoDataPaths
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static File	glimpseTopoCacheDir	Standard dir for TOPO cache data.
static File	glimpseTopoDataDir	Standard dir for TOPO permanent data.
static File	glimpseTopoDefaultSharedDataDir	Most code should NOT use this, but should use glimpseTopoDataDir instead.
static File	glimpseTopoDefaultUserDataDir	Most code should NOT use this, but should use glimpseTopoDataDir instead.
static com.google.common.collect.ImmutableList<String>	topoDataFileRoots
static com.google.common.collect.ImmutableList<String>	topoDataFileSuffixes

Constructor Summary

Constructors

Constructor	Description
TopoDataPaths()

Method Summary

Modifier and Type	Method	Description
static File	findTopoDataFile(File dir)
static File	requireTopoDataFile()
static File	requireTopoDataFile(File dir)

Methods inherited from class java.lang.Object

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

Field Detail

glimpseTopoDefaultUserDataDir

public static final File glimpseTopoDefaultUserDataDir

Most code should NOT use this, but should use glimpseTopoDataDir instead. This is provided for code that, for some reason, needs to bypass the ( userDir || sharedDir ) fallback behavior and access the user dir specifically.

glimpseTopoDefaultSharedDataDir

public static final File glimpseTopoDefaultSharedDataDir

Most code should NOT use this, but should use glimpseTopoDataDir instead. This is provided for code that, for some reason, needs to bypass the ( userDir || sharedDir ) fallback behavior and access the shared dir specifically.

glimpseTopoDataDir

public static final File glimpseTopoDataDir

Standard dir for TOPO permanent data.

1. JVM prop (if defined): glimpse.topo.dataDir
2. Env var (if defined): GLIMPSE_TOPO_DATA
3. User default (if dir exists): subdir TOPO of GlimpseDataPaths.glimpseUserDataDir
4. Shared default: subdir TOPO of GlimpseDataPaths.glimpseSharedDataDir

topoDataFileRoots

public static final com.google.common.collect.ImmutableList<String> topoDataFileRoots

topoDataFileSuffixes

public static final com.google.common.collect.ImmutableList<String> topoDataFileSuffixes

glimpseTopoCacheDir

public static final File glimpseTopoCacheDir

Standard dir for TOPO cache data.

1. JVM prop (if defined): glimpse.topo.cacheDir
2. Env var (if defined): GLIMPSE_TOPO_CACHE
3. Default: subdir TOPO_CACHE of GlimpseDataPaths.glimpseUserCacheDir

Constructor Detail

TopoDataPaths

public TopoDataPaths()

Method Detail

requireTopoDataFile

public static File requireTopoDataFile()

requireTopoDataFile

public static File requireTopoDataFile(File dir)

findTopoDataFile

public static File findTopoDataFile(File dir)