MappingDiscoverer.java

/*
 * Copyright 2012-2014 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
 *
 *      http://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.core;

import java.lang.reflect.Method;

/**
 * Strategy interface to discover a URI mapping for either a given type or method.
 * 
 * @author Oliver Gierke
 */
public interface MappingDiscoverer {

	/**
	 * Returns the mapping associated with the given type.
	 * 
	 * @param type must not be {@literal null}.
	 * @return the type-level mapping or {@literal null} in case none is present.
	 */
	String getMapping(Class<?> type);

	/**
	 * Returns the mapping associated with the given {@link Method}. This will include the type-level mapping.
	 * 
	 * @param method must not be {@literal null}.
	 * @return the method mapping including the type-level one or {@literal null} if neither of them present.
	 */
	String getMapping(Method method);

	/**
	 * Returns the mapping for the given {@link Method} invoked on the given type. This can be used to calculate the
	 * mapping for a super type method being invoked on a sub-type with a type mapping.
	 * 
	 * @param type must not be {@literal null}.
	 * @param method must not be {@literal null}.
	 * @return the method mapping including the type-level one or {@literal null} if neither of them present.
	 */
	String getMapping(Class<?> type, Method method);
}