http://micronaut.io: Natively Cloud Native
  • Graeme Rocher 
/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.http.hateoas;

import io.micronaut.core.value.OptionalMultiValues;


Represents a REST resource in a hateoas architecture.

Author:Graeme Rocher
Since:1.1
/**
 * Represents a REST resource in a hateoas architecture.
 *
 * @author Graeme Rocher
 * @since 1.1
 */
public interface Resource {

    
The links attribute.

/**
     * The links attribute.
     */
    String LINKS = "_links";

    
The embedded attribute.

/**
     * The embedded attribute.
     */
    String EMBEDDED = "_embedded";

    
Returns:The links for this resource
/**
     * @return The links for this resource
     */
    default OptionalMultiValues<? extends Link> getLinks() {
        return OptionalMultiValues.empty();
    }

    
Returns:The embedded resources
/**
     * @return The embedded resources
     */
    default OptionalMultiValues<? extends Resource> getEmbedded() {
        return OptionalMultiValues.empty();
    }
}