Package com.structurizr

Class Workspace

java.lang.Object

com.structurizr.AbstractWorkspace

com.structurizr.Workspace

All Implemented Interfaces:

Documentable, PropertyHolder

public final class Workspace
extends AbstractWorkspace
implements Documentable

Represents a Structurizr workspace, which is a wrapper for a software architecture model, views and documentation.

Constructor Summary

Constructors

Constructor	Description
Workspace(String name, String description)	Creates a new workspace.

Method Summary

Modifier and Type	Method	Description
int	countAndLogWarnings()	Counts and logs any warnings within the workspace (e.g.
Documentation	getDocumentation()	Gets the documentation associated with this workspace.
Model	getModel()	Gets the software architecture model.
ViewSet	getViews()	Gets the set of views onto a software architecture model.
void	hydrate()	Called when deserialising JSON, to re-create the object graph based upon element/relationship IDs.
boolean	isEmpty()	Determines whether this model is empty.

Methods inherited from class com.structurizr.AbstractWorkspace

addProperty, clearConfiguration, getConfiguration, getDescription, getId, getLastModifiedAgent, getLastModifiedDate, getLastModifiedUser, getName, getProperties, getRevision, getThumbnail, getVersion, setConfiguration, setDescription, setId, setLastModifiedAgent, setLastModifiedDate, setLastModifiedUser, setName, setRevision, setThumbnail, setVersion

Methods inherited from class java.lang.Object

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

Constructor Details

Workspace

public Workspace(String name,
 String description)

Creates a new workspace.

Parameters:

name - the name of the workspace

description - a short description

Method Details

getModel

public Model getModel()

Gets the software architecture model.

Returns:

a Model instance

getViews

public ViewSet getViews()

Gets the set of views onto a software architecture model.

Returns:

a ViewSet instance

hydrate

public void hydrate()

Called when deserialising JSON, to re-create the object graph based upon element/relationship IDs.

getDocumentation

public Documentation getDocumentation()

Gets the documentation associated with this workspace.

Specified by:

getDocumentation in interface Documentable

Returns:

a Documentation object

isEmpty

public boolean isEmpty()

Determines whether this model is empty.

Returns:

true if the model has no elements, views or documentation; false otherwise

countAndLogWarnings

public int countAndLogWarnings()

Counts and logs any warnings within the workspace (e.g. missing element descriptions).

Returns:

the number of warnings