org.modeshape.web.jcr.rest.client.domain

## Class Workspace

- java.lang.Object
- - org.modeshape.web.jcr.rest.client.domain.Workspace

- All Implemented Interfaces:
    IModeShapeObject

      @Immutable
      public class Workspace
      extends Object
      implements IModeShapeObject

  The `Workspace` class is the business object for a ModeShape repository workspace.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `Workspace(String name, Repository repository)` Constructs a new `Workspace`.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object obj)`
    `String` | `getName()`
    `Repository` | `getRepository()`
    `Server` | `getServer()`
    `String` | `getShortDescription()`
    `int` | `hashCode()`
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### Workspace

          public Workspace(String name,
                   Repository repository)

      Constructs a new `Workspace`.
      Parameters:
        `name` - the workspace name (never `null`)
        `repository` - the repository where this workspace resides (never `null`)
      Throws:
        `IllegalArgumentException` - if any of the arguments are `null`

  - ### Method Detail

    - #### equals

          public boolean equals(Object obj)

      Overrides:
        `equals` in class `Object`

    - #### getName

          public String getName()

      Specified by:
        `getName` in interface `IModeShapeObject`
      Returns:
        the object name (never `null`)

    - #### getRepository

          public Repository getRepository()

      Returns:
        the repository where this workspace is located (never `null`)

    - #### getServer

          public Server getServer()

      Returns:
        the server where this workspace is located (never `null`)

    - #### getShortDescription

          public String getShortDescription()

      Specified by:
        `getShortDescription` in interface `IModeShapeObject`
      Returns:
        a description suitable for use in a tooltip (never `null`)

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.