ReadyApiPaths (ReadyAPI core SDK 3.2.0)

ReadyApiPaths

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`READY_API_HOME_DIR`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.String`	`absolutePath(java.nio.file.Path path)`
	`static java.nio.file.Path`	`ensureExists(java.nio.file.Path path)` Gets a Path which definitely exists.
	`static java.nio.file.Path`	`ensureExistsAndCanWrite(java.nio.file.Path path)` Gets a Path which definitely exists and can be written to.
	`static java.nio.file.Path`	`readyApiDataDir()` Returns: the ReadyAPI data directory.
	`static java.nio.file.Path`	`readyApiHomeDir()` Returns: the ReadyAPI home directory (installation location).
	`static java.nio.file.Path`	`readyApiLogDir()` Returns: the ReadyAPI log directory.
	`static java.nio.file.Path`	`readyApiVirtLogDir()` Returns: the ReadyAPI log directory for virts.
	`static java.nio.file.Path`	`relativeToReadyApiDataDir(java.lang.String path, java.lang.String paths)` Parameters: `path` - initial path
	`static java.nio.file.Path`	`relativeToReadyApiHomeDir(java.lang.String path, java.lang.String paths)` Parameters: `path` - initial path
	`static java.nio.file.Path`	`serviceVHomeDir()` Returns: the ServiceV home directory (installation location).

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String READY_API_HOME_DIR
- Method Detail
  - public static java.lang.String absolutePath(java.nio.file.Path path)
  - public static java.nio.file.Path ensureExists(java.nio.file.Path path)
    
    Gets a Path which definitely exists. Attempts to create the Path if necessary.
    Parameters:
    path
    Returns:
    Path if it exists (or can be created).
  - public static java.nio.file.Path ensureExistsAndCanWrite(java.nio.file.Path path)
    
    Gets a Path which definitely exists and can be written to. Attempts to create the Path if necessary.
    Parameters:
    path
    Returns:
    Path if it exists (or can be created) and can be written to.
  - public static java.nio.file.Path readyApiDataDir()
    
    throws:
    java.lang.RuntimeException if cannot get a home directory or write to the resolved directory.
    
    Returns:
    the ReadyAPI data directory. Creates it if necessary.
  - public static java.nio.file.Path readyApiHomeDir()
    
    throws:
    java.lang.RuntimeException if cannot get a home directory or write to the resolved directory.
    
    Returns:
    the ReadyAPI home directory (installation location). Creates it if necessary.
  - public static java.nio.file.Path readyApiLogDir()
    
    throws:
    java.lang.RuntimeException if cannot get a home directory or write to the resolved directory.
    
    Returns:
    the ReadyAPI log directory. Creates it if necessary.
  - public static java.nio.file.Path readyApiVirtLogDir()
    
    throws:
    java.lang.RuntimeException if cannot get a home directory or write to the resolved directory.
    
    Returns:
    the ReadyAPI log directory for virts. Creates it if necessary.
  - public static java.nio.file.Path relativeToReadyApiDataDir(java.lang.String path, java.lang.String paths)
    
    Parameters:
    path - initial path
    paths - sub-paths
    Returns:
    Path relative to ReadyAPI data directory
  - public static java.nio.file.Path relativeToReadyApiHomeDir(java.lang.String path, java.lang.String paths)
    
    Parameters:
    path - initial path
    paths - sub-paths
    Returns:
    Path relative to ReadyAPI home
  - public static java.nio.file.Path serviceVHomeDir()
    
    throws:
    java.lang.RuntimeException if cannot get a home directory or write to the resolved directory.
    
    Returns:
    the ServiceV home directory (installation location). Creates it if necessary.

Summary:
Field
Method

| Detail:
Field
Method

ReadyAPI core SDK 3.2.0

[Java] Class ReadyApiPaths

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String READY_API_HOME_DIR

Method Detail

public static java.lang.String absolutePath(java.nio.file.Path path)

public static java.nio.file.Path ensureExists(java.nio.file.Path path)

public static java.nio.file.Path ensureExistsAndCanWrite(java.nio.file.Path path)

public static java.nio.file.Path readyApiDataDir()

public static java.nio.file.Path readyApiHomeDir()

public static java.nio.file.Path readyApiLogDir()

public static java.nio.file.Path readyApiVirtLogDir()

public static java.nio.file.Path relativeToReadyApiDataDir(java.lang.String path, java.lang.String paths)

public static java.nio.file.Path relativeToReadyApiHomeDir(java.lang.String path, java.lang.String paths)

public static java.nio.file.Path serviceVHomeDir()