org.springframework.hateoas.Affordance.java Source code

Introduction

Here is the source code for org.springframework.hateoas.Affordance.java

Source

/*
 * Copyright 2017-2019 the original author or 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 org.springframework.hateoas;

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Value;

import java.util.Iterator;
import java.util.Map;

import org.springframework.http.MediaType;
import org.springframework.lang.Nullable;

/**
 * Hold the {@link AffordanceModel}s for all supported media types.
 *
 * @author Greg Turnquist
 * @author Oliver Gierke
 */
@Value
public class Affordance implements Iterable<AffordanceModel> {

    /**
     * Collection of {@link AffordanceModel}s related to this affordance.
     */
    @Getter(AccessLevel.PACKAGE) //
    private final Map<MediaType, AffordanceModel> models;

    /**
     * Look up the {@link AffordanceModel} for the requested {@link MediaType}.
     *
     * @param mediaType
     * @return
     */
    @Nullable
    @SuppressWarnings("unchecked")
    public <T extends AffordanceModel> T getAffordanceModel(MediaType mediaType) {
        return (T) this.models.get(mediaType);
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Iterable#iterator()
     */
    @Override
    public Iterator<AffordanceModel> iterator() {
        return models.values().iterator();
    }
}