org.http4s.rho.hal

ResourceObject

Related Doc: package hal

case class ResourceObject[T, E](links: Links = Nil, embedded: Embedded[E] = Nil, content: Option[T] = None) extends Product with Serializable

A Resource Object represents a resource.

links

contains links to other resources

The "links" property is OPTIONAL.

It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing "_links" object is a property.

embedded

contains embedded resources

The "embedded" property is OPTIONAL

It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Resource Object or an array of Resource Objects.

Embedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI.

content

represents an object that contains all other properties

All properties of the content instance will be rendered as JSON, and represent the current state of the resource.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ResourceObject
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ResourceObject(links: Links = Nil, embedded: Embedded[E] = Nil, content: Option[T] = None)

    links

    contains links to other resources

    The "links" property is OPTIONAL.

    It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing "_links" object is a property.

    embedded

    contains embedded resources

    The "embedded" property is OPTIONAL

    It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Resource Object or an array of Resource Objects.

    Embedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI.

    content

    represents an object that contains all other properties

    All properties of the content instance will be rendered as JSON, and represent the current state of the resource.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. val content: Option[T]

    represents an object that contains all other properties

    represents an object that contains all other properties

    All properties of the content instance will be rendered as JSON, and represent the current state of the resource.

  7. val embedded: Embedded[E]

    contains embedded resources

    contains embedded resources

    The "embedded" property is OPTIONAL

    It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Resource Object or an array of Resource Objects.

    Embedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI.

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  12. val links: Links

    contains links to other resources

    contains links to other resources

    The "links" property is OPTIONAL.

    It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing "_links" object is a property.

  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  17. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped