Package com.structurizr
Class Workspace
java.lang.Object
com.structurizr.AbstractWorkspace
com.structurizr.Workspace
- All Implemented Interfaces:
Documentable
,PropertyHolder
Represents a Structurizr workspace, which is a wrapper for a
software architecture model, views and documentation.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Counts and logs any warnings within the workspace (e.g.Gets the documentation associated with this workspace.getModel()
Gets the software architecture model.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
-
Constructor Details
-
Workspace
Creates a new workspace.- Parameters:
name
- the name of the workspacedescription
- a short description
-
-
Method Details
-
getModel
Gets the software architecture model.- Returns:
- a Model instance
-
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
Gets the documentation associated with this workspace.- Specified by:
getDocumentation
in interfaceDocumentable
- 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
-