How to use

assertThatTheViewKeyIsSpecifiedAndUnique

method

in

com.structurizr.view.ViewSet

/**
 * Creates a system landscape view.
 *
 * @param key           the key for the view (must be unique)
 * @param description   a description of the view
 * @return              an SystemLandscapeView object
 * @throws              IllegalArgumentException if the key is not unique
 */
public SystemLandscapeView createSystemLandscapeView(String key, String description) {
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  SystemLandscapeView view = new SystemLandscapeView(model, key, description);
  view.setViewSet(this);
  systemLandscapeViews.add(view);
  return view;
}

/**
 * Creates a dynamic view.
 *
 * @param key           the key for the view (must be unique)
 * @param description   a description of the view
 * @return              a DynamicView object
 * @throws              IllegalArgumentException if the key is not unique
 */
public DynamicView createDynamicView(String key, String description) {
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  DynamicView view = new DynamicView(model, key, description);
  view.setViewSet(this);
  dynamicViews.add(view);
  return view;
}

/**
 * Creates a deployment view.
 *
 * @param key           the key for the deployment view (must be unique)
 * @param description   a description of the  view
 * @return              a DeploymentView object
 * @throws              IllegalArgumentException if the key is not unique
 */
public DeploymentView createDeploymentView(String key, String description) {
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  DeploymentView view = new DeploymentView(model, key, description);
  view.setViewSet(this);
  deploymentViews.add(view);
  return view;
}

/**
 * Creates a FilteredView on top of an existing static view.
 *
 * @param view          the static view to base the FilteredView upon
 * @param key           the key for the filtered view (must be unique)
 * @param description   a description
 * @param mode          whether to Include or Exclude elements/relationships based upon their tag
 * @param tags          the tags to include or exclude
 * @return              a FilteredView object
 */
public FilteredView createFilteredView(StaticView view, String key, String description, FilterMode mode, String... tags) {
  assertThatTheViewIsNotNull(view);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  FilteredView filteredView = new FilteredView(view, key, description, mode, tags);
  filteredViews.add(filteredView);
  return filteredView;
}

/**
 * Creates a system context view, where the scope of the view is the specified software system.
 *
 * @param softwareSystem    the SoftwareSystem object representing the scope of the view
 * @param key               the key for the view (must be unique)
 * @param description       a description of the view
 * @return                  a SystemContextView object
 * @throws                  IllegalArgumentException if the software system is null or the key is not unique
 */
public SystemContextView createSystemContextView(SoftwareSystem softwareSystem, String key, String description) {
  assertThatTheSoftwareSystemIsNotNull(softwareSystem);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  SystemContextView view = new SystemContextView(softwareSystem, key, description);
  view.setViewSet(this);
  systemContextViews.add(view);
  return view;
}

/**
 * Creates a container view, where the scope of the view is the specified software system.
 *
 * @param softwareSystem    the SoftwareSystem object representing the scope of the view
 * @param key               the key for the view (must be unique)
 * @param description       a description of the view
 * @return                  a ContainerView object
 * @throws                  IllegalArgumentException if the software system is null or the key is not unique
 */
public ContainerView createContainerView(SoftwareSystem softwareSystem, String key, String description) {
  assertThatTheSoftwareSystemIsNotNull(softwareSystem);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  ContainerView view = new ContainerView(softwareSystem, key, description);
  view.setViewSet(this);
  containerViews.add(view);
  return view;
}

/**
 * Creates a deployment view, where the scope of the view is the specified software system.
 *
 * @param softwareSystem    the SoftwareSystem object representing the scope of the view
 * @param key               the key for the deployment view (must be unique)
 * @param description       a description of the view
 * @return                  a DeploymentView object
 * @throws                  IllegalArgumentException if the software system is null or the key is not unique
 */
public DeploymentView createDeploymentView(SoftwareSystem softwareSystem, String key, String description) {
  assertThatTheSoftwareSystemIsNotNull(softwareSystem);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  DeploymentView view = new DeploymentView(softwareSystem, key, description);
  view.setViewSet(this);
  deploymentViews.add(view);
  return view;
}

/**
 * Creates a component view, where the scope of the view is the specified container.
 *
 * @param container         the Container object representing the scope of the view
 * @param key               the key for the view (must be unique)
 * @param description       a description of the view
 * @return                  a ContainerView object
 * @throws                  IllegalArgumentException if the container is null or the key is not unique
 */
public ComponentView createComponentView(Container container, String key, String description) {
  assertThatTheContainerIsNotNull(container);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  ComponentView view = new ComponentView(container, key, description);
  view.setViewSet(this);
  componentViews.add(view);
  return view;
}

/**
 * Creates a dynamic view, where the scope is the specified software system. The following
 * elements can be added to the resulting view:
 *
 * <ul>
 * <li>People</li>
 * <li>Software systems</li>
 * <li>Containers that reside inside the specified software system</li>
 * </ul>
 *
 * @param softwareSystem    the SoftwareSystem object representing the scope of the view
 * @param key               the key for the view (must be unique)
 * @param description       a description of the view
 * @return                  a DynamicView object
 * @throws                  IllegalArgumentException if the software system is null or the key is not unique
 */
public DynamicView createDynamicView(SoftwareSystem softwareSystem, String key, String description) {
  assertThatTheSoftwareSystemIsNotNull(softwareSystem);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  DynamicView view = new DynamicView(softwareSystem, key, description);
  view.setViewSet(this);
  dynamicViews.add(view);
  return view;
}

/**
 * Creates a dynamic view, where the scope is the specified container. The following
 * elements can be added to the resulting view:
 *
 * <ul>
 * <li>People</li>
 * <li>Software systems</li>
 * <li>Containers with the same parent software system as the specified container</li>
 * <li>Components within the specified container</li>
 * </ul>
 *
 * @param container         the Container object representing the scope of the view
 * @param key               the key for the view (must be unique)
 * @param description       a description of the view
 * @return                  a DynamicView object
 * @throws                  IllegalArgumentException if the container is null or the key is not unique
 */
public DynamicView createDynamicView(Container container, String key, String description) {
  assertThatTheContainerIsNotNull(container);
  assertThatTheViewKeyIsSpecifiedAndUnique(key);
  DynamicView view = new DynamicView(container, key, description);
  view.setViewSet(this);
  dynamicViews.add(view);
  return view;
}