OutputSettings (Attestor 0.3.5-SEFM2018 API)

java.lang.Object
- de.rwth.i2.attestor.phases.communication.OutputSettings

```
public class OutputSettings
extends Object
```
All communication related to exporting artifacts.

Author:

Hannah Arndt, Christoph

Constructor Summary

Constructors
Constructor and Description

OutputSettings()

Constructors
Constructor and Description
`OutputSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomHc(String label, HeapConfiguration hc)` Adds a new graph to the list of custom graphs, that should be exported for debugging purpose.
`void`	`addRequiredContractForReuse(String signature, String filename)` Adds a pair requested signature and filename to the set of requested contracts
`Map<String,String>`	`getContractForReuseRequests()` A mapping from the signatures for which contracts are requested and the names of the files the exported contracts are stored in.
`List<HcLabelPair>`	`getCustomHcSet()`
`String`	`getDirectoryForReuseContracts()`
`String`	`getLocationForContractsForInspection()`
`String`	`getLocationForCustomHcs()`
`String`	`getLocationForGrammar()`
`String`	`getLocationForStateSpace()`
`boolean`	`isExportContractsForInspection()`
`boolean`	`isExportContractsForReuse()`
`boolean`	`isExportCustomHcs()`
`boolean`	`isExportGrammar()`
`boolean`	`isExportStateSpace()`
`boolean`	`isNoExport()`
`boolean`	`isValid()` Checks whether all necessary paths and names are present for objects that should be exported.
`void`	`setDefaultPath(String path)` Sets the default path for all exports.
`void`	`setDirectoryForReuseContracts(String directory)` Defines where the exported contracts should be stored
`void`	`setExportContractsForInspection(boolean exportContracts)`
`void`	`setExportContractsForReuse(boolean exportContracts)`
`void`	`setExportCustomHcs(boolean exportCustomHcs)`
`void`	`setExportGrammar(boolean exportGrammar)`
`void`	`setExportStateSpace(boolean exportStateSpace)`
`void`	`setFolderForContractsForInspection(String folderForContracts)`
`void`	`setFolderForCustomHcs(String folderForCustomHcs)`
`void`	`setFolderForGrammar(String folderForGrammar)`
`void`	`setFolderForStateSpace(String folderForStateSpace)`
`void`	`setNoExport(boolean enabled)`
`void`	`setPathForContractsForInspection(String pathForContracts)`
`void`	`setPathForCustomHcs(String pathForCustomHcs)`
`void`	`setPathForGrammar(String pathForGrammar)`
`void`	`setPathForStateSpace(String pathForStateSpace)`
`void`	`setRootPath(String rootPath)`

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

- Constructor Detail
  - OutputSettings
```
public OutputSettings()
```
- Method Detail
  - isNoExport
```
public boolean isNoExport()
```
    Returns:
    
    True if and only if no export should be performed.
  - setNoExport
```
public void setNoExport(boolean enabled)
```
    Parameters:
    
    enabled - True if no export should be performed.
  - setDefaultPath
```
public void setDefaultPath(String path)
```
    Sets the default path for all exports.
    
    Parameters:
    
    path - The default path.
  - isExportStateSpace
```
public boolean isExportStateSpace()
```
    Returns:
    
    True if and only if the generated state space should be exported.
  - setExportStateSpace
```
public void setExportStateSpace(boolean exportStateSpace)
```
    Parameters:
    
    exportStateSpace - True if and only if the generated state space should be exported.
  - setPathForStateSpace
```
public void setPathForStateSpace(String pathForStateSpace)
```
    Parameters:
    
    pathForStateSpace - The path where exported state spaces are stored.
  - setFolderForStateSpace
```
public void setFolderForStateSpace(String folderForStateSpace)
```
    Parameters:
    
    folderForStateSpace - The directory that is created and containsSubsumingState the exported state space.
  - getLocationForStateSpace
```
public String getLocationForStateSpace()
```
    Returns:
    
    The directory that is created and containsSubsumingState the exported state space.
  - isExportGrammar
```
public boolean isExportGrammar()
```
    Returns:
    
    True if and only if loaded grammars should be exported.
  - setExportGrammar
```
public void setExportGrammar(boolean exportGrammar)
```
    Parameters:
    
    exportGrammar - True if and only if loaded grammars should be exported.
  - setPathForGrammar
```
public void setPathForGrammar(String pathForGrammar)
```
    Parameters:
    
    pathForGrammar - The path where exported grammars are stored.
  - setFolderForGrammar
```
public void setFolderForGrammar(String folderForGrammar)
```
    Parameters:
    
    folderForGrammar - The directory containing exported grammars.
  - getLocationForGrammar
```
public String getLocationForGrammar()
```
    Returns:
    
    The fully qualified path to the directory containing exported grammars.
  - isExportContractsForInspection
```
public boolean isExportContractsForInspection()
```
    Returns:
    
    True if and only if used contracts should be exported.
  - setExportContractsForInspection
```
public void setExportContractsForInspection(boolean exportContracts)
```
    Parameters:
    
    exportContracts - True if and only if used contracts should be exported for inspection.
  - setPathForContractsForInspection
```
public void setPathForContractsForInspection(String pathForContracts)
```
    Parameters:
    
    pathForContracts - The path where exported contracts for inspection are stored.
  - setFolderForContractsForInspection
```
public void setFolderForContractsForInspection(String folderForContracts)
```
    Parameters:
    
    folderForContracts - The directory containing exported contracts for inspection.
  - getLocationForContractsForInspection
```
public String getLocationForContractsForInspection()
```
    Returns:
    
    The fully qualified path to the directory containing exported contracts for inspection.
  - isExportCustomHcs
```
public boolean isExportCustomHcs()
```
    Returns:
    
    True if and only if custom HCs should be exported (for debugging purpose).
  - setExportCustomHcs
```
public void setExportCustomHcs(boolean exportCustomHcs)
```
    Parameters:
    
    exportCustomHcs - True if and only if the generated state space should be exported.
  - addCustomHc
```
public void addCustomHc(String label,
                        HeapConfiguration hc)
```
    Adds a new graph to the list of custom graphs, that should be exported for debugging purpose.
    
    Parameters:
    
    label, - the identifier of the graphs
    
    hc, - the graph itself
  - setPathForCustomHcs
```
public void setPathForCustomHcs(String pathForCustomHcs)
```
    Parameters:
    
    pathForCustomHcs - The path where exported custom hcs are stored.
  - setFolderForCustomHcs
```
public void setFolderForCustomHcs(String folderForCustomHcs)
```
    Parameters:
    
    folderForCustomHcs - The directory that is created and containsSubsumingState the exported custom hcs.
  - getLocationForCustomHcs
```
public String getLocationForCustomHcs()
```
    Returns:
    
    The directory that is created and containsSubsumingState the exported state space.
  - isExportContractsForReuse
```
public boolean isExportContractsForReuse()
```
  - setExportContractsForReuse
```
public void setExportContractsForReuse(boolean exportContracts)
```
    Parameters:
    
    exportContracts - true if and only if (some) contracts should be exported.
  - getDirectoryForReuseContracts
```
public String getDirectoryForReuseContracts()
```
    Returns:
    
    The directory that is created and contains the exported contracts.
  - setDirectoryForReuseContracts
```
public void setDirectoryForReuseContracts(String directory)
```
    Defines where the exported contracts should be stored
    
    Parameters:
    
    directory -
  - getContractForReuseRequests
```
public Map<String,String> getContractForReuseRequests()
```
    A mapping from the signatures for which contracts are requested and the names of the files the exported contracts are stored in.
    
    Returns:
  - addRequiredContractForReuse
```
public void addRequiredContractForReuse(String signature,
                                        String filename)
```
    Adds a pair requested signature and filename to the set of requested contracts
    
    Parameters:
    
    signature - the signature of the method whose contract is requested
    
    filename - the name of the file where the contract should be written to.
  - isValid
```
public boolean isValid()
```
    Checks whether all necessary paths and names are present for objects that should be exported.
    
    Returns:
    
    True if and only if the current communication are consistent in the above sense.
  - setRootPath
```
public void setRootPath(String rootPath)
```
  - getCustomHcSet
```
public List<HcLabelPair> getCustomHcSet()
```

Class OutputSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OutputSettings

Method Detail

isNoExport

setNoExport

setDefaultPath

isExportStateSpace

setExportStateSpace

setPathForStateSpace

setFolderForStateSpace

getLocationForStateSpace

isExportGrammar

setExportGrammar

setPathForGrammar

setFolderForGrammar

getLocationForGrammar

isExportContractsForInspection

setExportContractsForInspection

setPathForContractsForInspection

setFolderForContractsForInspection

getLocationForContractsForInspection

isExportCustomHcs

setExportCustomHcs

addCustomHc

setPathForCustomHcs

setFolderForCustomHcs

getLocationForCustomHcs

isExportContractsForReuse

setExportContractsForReuse

getDirectoryForReuseContracts

setDirectoryForReuseContracts

getContractForReuseRequests

addRequiredContractForReuse

isValid

setRootPath

getCustomHcSet