Package com.structurizr.dsl

Class StructurizrDslFormatter

java.lang.Object

com.structurizr.dsl.StructurizrDslFormatter

public final class StructurizrDslFormatter
extends Object

Formats a Structurizr JSON workspace to DSL. This implementation isn't perfect, but it should help anybody wanting to transition to the DSL.

Constructor Summary

Constructors

Constructor	Description
StructurizrDslFormatter()

Method Summary

Modifier and Type	Method	Description
String	format(File file)	Formats the specified Structurizr JSON file to the Structurizr DSL.
String	format(String json)	Formats the specified Structurizr JSON to the Structurizr DSL.

Methods inherited from class java.lang.Object

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

Constructor Details

StructurizrDslFormatter

public StructurizrDslFormatter()

Method Details

format

public String format(File file)
              throws StructurizrDslFormatterException

Formats the specified Structurizr JSON file to the Structurizr DSL.

Parameters:

file - a File object representing a JSON file

Returns:

a DSL representation of the workspace

Throws:

StructurizrDslFormatterException - if the workspace can't be formatted

format

public String format(String json)
              throws StructurizrDslFormatterException

Formats the specified Structurizr JSON to the Structurizr DSL.

Parameters:

json - a JSON document

Returns:

a DSL representation of the workspace

Throws:

StructurizrDslFormatterException - if the workspace can't be formatted