IProvideRestDoc.java

package org.restdoc.server.impl;

/*
 * #%L Java Server implementation %% Copyright (C) 2012 RestDoc org %% 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. #L%
 */

import java.util.Map;

import org.restdoc.api.RestResource;
import org.restdoc.api.Schema;

/**
 * This class provide methods to retrieve the RestDoc without parsing the Annotations
 */
public interface IProvideRestDoc {
	
	/**
	 * @return the array of resources this class provides
	 */
	RestResource[] getRestDocResources();
	
	/**
	 * @return a map of provided schemas
	 */
	Map<String, Schema> getRestDocSchemas();
	
}