org.anadix.Source Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Tomas Schlosser
 *
 * 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.anadix;

import java.io.InputStream;
import java.io.Reader;

/**
 * Represents a source for analysis
 *
 * @author tomason
 * @version $Id: $
 */
public interface Source {
	/**
	 * Gets the description of the source (eg. filename, url, classpath)
	 *
	 * @return description of the source
	 */
	String getDescription();

	/**
	 * Gets the source as a String. If for example the source reads a stream then the whole stream is read and returned as a String.
	 *
	 * @return source as a String
	 */
	String getText();

	/**
	 * Gets reader representation of the source
	 *
	 * @return source as a Reader
	 */
	Reader getReader();

	/**
	 * Gets stream representation of the source
	 *
	 * @return source as a Stream
	 */
	InputStream getStream();
}