NamedQueries.java

/*
 * Copyright 2011 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.data.repository.core;

/**
 * Abstraction of a map of {@link NamedQueries} that can be looked up by their names.
 * 
 * @author Oliver Gierke
 */
public interface NamedQueries {

	/**
	 * Returns whether the map contains a named query for the given name. If this method returns {@literal true} you can
	 * expect {@link #getQuery(String)} to return a non-{@literal null} query for the very same name.
	 * 
	 * @param queryName
	 * @return
	 */
	boolean hasQuery(String queryName);

	/**
	 * Returns the named query with the given name or {@literal null} if none exists.
	 * 
	 * @param queryName
	 * @return
	 */
	String getQuery(String queryName);
}