org.springframework.hateoas.Affordance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-hateoas Show documentation

Library to support implementing representations for hyper-text driven REST web services.

There is a newer version: 2.4.0

/*
 * Copyright 2017-2023 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 java.util.Iterator;
import java.util.Map;
import java.util.Objects;

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
 */
public final class Affordance implements Iterable {

	/**
	 * Collection of {@link AffordanceModel}s related to this affordance.
	 */
	private final Map models;

	public Affordance(Map models) {
		this.models = models;
	}

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

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

	Map getModels() {
		return this.models;
	}

	@Override
	public boolean equals(@Nullable Object o) {

		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}
		Affordance that = (Affordance) o;
		return Objects.equals(this.models, that.models);
	}

	@Override
	public int hashCode() {
		return Objects.hash(this.models);
	}

	@Override
	public String toString() {
		return "Affordance(models=" + this.models + ")";
	}
}