SeuacLayout (seuac-base-plugin 2.0.1 API)

de.qaware.seu.as.code.plugins.base.SeuacLayout

Simple data type to represent the directory layout of a SEU.
Authors:
lreimer

Properties Summary

Properties
Type	Name and description
`java.io.File`	`codebase`
`java.io.File`	`docbase`
`java.io.File`	`home`
`java.io.File`	`repository`
`java.io.File`	`software`
`java.io.File`	`temp`

Methods Summary

Methods
Type	Name and description
`void`	`codebase(java.io.File aDir)` Short hand method to assign the given file as codebase directory.
`void`	`codebase(java.lang.String aDir)` Short hand method to assign the given path as codebase directory.
`static SeuacLayout`	`defaultLayout(java.lang.Object seuHome)` Factory method to create a defaut SEU-as-Code layout for the given SEU home.
`void`	`docbase(java.io.File aDir)` Short hand method to assign the given file as docbase directory.
`void`	`docbase(java.lang.String aDir)` Short hand method to assign the given path as docbase directory.
`java.lang.Object`	`getDirectories()` Returns the list of directories for this layout.
`void`	`home(java.io.File aDir)` Short hand method to assign the given file as home directory.
`void`	`home(java.lang.String aDir)` Short hand method to assign the given path as home directory.
`void`	`mkdirs()` Utility method to create the directories for this layout instance.
`void`	`repository(java.io.File aDir)` Short hand method to assign the given file as repository directory.
`void`	`repository(java.lang.String aDir)` Short hand method to assign the given path as repository directory.
`void`	`software(java.io.File aDir)` Short hand method to assign the given file as software directory.
`void`	`software(java.lang.String aDir)` Short hand method to assign the given path as software directory.
`void`	`temp(java.io.File aDir)` Short hand method to assign the given file as temp directory.
`void`	`temp(java.lang.String aDir)` Short hand method to assign the given path as temp directory.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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()`

- Property Detail
  - java.io.File codebase
  - java.io.File docbase
  - java.io.File home
  - java.io.File repository
  - java.io.File software
  - java.io.File temp
- Method Detail
  - void codebase(java.io.File aDir)
    
    Short hand method to assign the given file as codebase directory.
    Parameters:
    aDir - the dir
  - void codebase(java.lang.String aDir)
    
    Short hand method to assign the given path as codebase directory.
    Parameters:
    aDir - the dir
  - static SeuacLayout defaultLayout(java.lang.Object seuHome)
    
    Factory method to create a defaut SEU-as-Code layout for the given SEU home.
    Returns:
    the default instance
    Parameters:
    seuHome - the SEU home
  - void docbase(java.io.File aDir)
    
    Short hand method to assign the given file as docbase directory.
    Parameters:
    aDir - the dir
  - void docbase(java.lang.String aDir)
    
    Short hand method to assign the given path as docbase directory.
    Parameters:
    aDir - the dir
  - java.lang.Object getDirectories()
    
    Returns the list of directories for this layout.
    Returns:
    the directory list
  - void home(java.io.File aDir)
    
    Short hand method to assign the given file as home directory.
    Parameters:
    aDir - the dir
  - void home(java.lang.String aDir)
    
    Short hand method to assign the given path as home directory.
    Parameters:
    aDir - the dir
  - void mkdirs()
    
    Utility method to create the directories for this layout instance.
    throws:
    IOException in case if I/O problems
  - void repository(java.io.File aDir)
    
    Short hand method to assign the given file as repository directory.
    Parameters:
    aDir - the dir
  - void repository(java.lang.String aDir)
    
    Short hand method to assign the given path as repository directory.
    Parameters:
    aDir - the dir
  - void software(java.io.File aDir)
    
    Short hand method to assign the given file as software directory.
    Parameters:
    aDir - the dir
  - void software(java.lang.String aDir)
    
    Short hand method to assign the given path as software directory.
    Parameters:
    aDir - the dir
  - void temp(java.io.File aDir)
    
    Short hand method to assign the given file as temp directory.
    Parameters:
    aDir - the dir
  - void temp(java.lang.String aDir)
    
    Short hand method to assign the given path as temp directory.
    Parameters:
    aDir - the dir

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class SeuacLayout

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.io.File codebase

java.io.File docbase

java.io.File home

java.io.File repository

java.io.File software

java.io.File temp

Method Detail

void codebase(java.io.File aDir)

void codebase(java.lang.String aDir)

static SeuacLayout defaultLayout(java.lang.Object seuHome)

void docbase(java.io.File aDir)

void docbase(java.lang.String aDir)

java.lang.Object getDirectories()

void home(java.io.File aDir)

void home(java.lang.String aDir)

void mkdirs()

void repository(java.io.File aDir)

void repository(java.lang.String aDir)

void software(java.io.File aDir)

void software(java.lang.String aDir)

void temp(java.io.File aDir)

void temp(java.lang.String aDir)