/*
 * The MIT License
 *
 * Copyright 2013 Dra0211.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package kinugasa.contents.resource;

import kinugasa.util.annotations.CastReturnValue;

/**
 * コンテンツが開放可能であることを表すインターフェースです.
 * <br>
 * このインターフェースは、メモリ空間を圧迫する可能性のあるクラスに実装されます。<br>
 * 明示的にロード／開放したり、アルゴリズムを切り替えるタイミングで不要となったリソースを
 * 自動開放するために使用します。<br>
 * <br>
 *
 * @version 1.0.0 - 2013/01/12_21:57:33<br>
 * @author Dra0211<br>
 */
public interface Freeable {

	/**
	 * コンテンツをロードして展開します.
	 * すでにロードされている場合の動作は、実装によって異なります。<br>
	 * 再度ロードすることで、データを最新のものに更新するなど、効果のある場合には、すでにロードされている場合でも
	 * 再度ロードすることがあります。<br>
	 *
	 * @return インスタンス化と同時にロードするために、thisインスタンスを返します。戻り値は
	 * 適切な型にキャストする必要があります。<br>
	 */
	@CastReturnValue
	public Freeable load();

	/**
	 * コンテンツをメモリから破棄出来るようにします.
	 * 実際にメモリから破棄されるタイミングは、GCに依存します。<br>
	 * まだロードされていないか、開放済みのオブジェクトを開放した場合には、通常は何も行いません。<br>
	 *
	 * @return デフォルトでロードされる実装を、インスタンス化と同時に開放するためにthisインスタンスを返します。<br>
	 * 戻り値は適切な型にキャストする必要があります。通常、このような実装は効率的でないため推奨されません。<br>
	 */
	@CastReturnValue
	public Freeable free();

	/**
	 * このオブジェクトが、すでにロードされているかを検査します.
	 *
	 * @return ロード済みである場合はtrueを返します。<br>
	 */
	public boolean isLoaded();
}
