Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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
`Workspace(String name, Repository repository)` Constructs a new `Workspace`.

Method Summary
`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`
  See Also:
    `Object.equals(java.lang.Object)`

### getName

    public String getName()

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

### 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`)
  See Also:
    `IModeShapeObject.getShortDescription()`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `Object`
  See Also:
    `Object.hashCode()`

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`
  See Also:
    `Object.toString()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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