FileLoader.java

/**************************************************************************
 * Copyright 2013 by Trixt0r
 * (https://github.com/Trixt0r, Heinrich Reich, e-mail: trixter16@web.de)
 *
 * 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 com.brashmonkey.spriter.file;

import java.util.ArrayList;
import java.util.HashMap;

/**
 * A FileLoader is an object which takes the task to load the resources a Spriter entity needs.
 * This is an abstract implementation and you need to extend this class and specify the logic of {@link #load(Reference, String)}.
 * @author Trixt0r
 * @param <I> Is a type which should be able to hold a specific resource of an entity, like a sprite.
 */
public abstract class FileLoader<I> {

	public HashMap<Reference,I> files = new HashMap<Reference,I>();

	abstract public void load(Reference ref, String path);
	
	/**
	 * Gets called if all resources have been passed to this loader. 
	 */
	public void finishLoading(){
		//TODO be implemented by your specific backend loader.
	}
	
	public I get(Reference ref){
		return files.get(ref);
	}
	
	/**
	 * @return Array of all loaded references by this loader.
	 */
	public Reference[] getRefs(){
		Reference[] refs = new Reference[this.files.keySet().toArray().length];
		this.files.keySet().toArray(refs);
		return refs;
	}
	
	/**
	 * Searches for a reference which is equal to the given one.
	 * Equal means: the folder and file of two references are the same.
	 * @param ref Reference to search after.
	 * @return Corresponding reference or null if not found.
	 */
	public Reference findReference(Reference ref){
		Reference[] refs = this.getRefs();
		for(Reference r: refs){
			if(r.equals(ref)) return r;
		}
		return null;
	}
	
	/**
	 * Searches for all files in the given folder name.
	 * @param folderName folder to search in
	 * @return array of all references which the given folder contains.
	 */
	public Reference[] findReferencesByFolderName(String folderName){
		Reference[] refs = this.getRefs();
		ArrayList<Reference> files = new ArrayList<Reference>();
		for(Reference ref: refs)
			if(ref.folderName.equals(folderName)) files.add(ref);
		return files.toArray(refs);
	}
	
	/**
	 * Searches for a reference with the given filename and returns it, if it exists.
	 * @param fileName name of the file (complete name with folder name and extension)
	 * @return reference with given filename or null if not found
	 */
	public Reference findReferenceByFileName(String fileName){
		Reference[] refs = this.getRefs();
		for(Reference ref: refs)
			if(ref.fileName.equals(fileName)) return ref;
		return null;
	}
	
	/**
	 * Searches for a reference with the given filename and folder id and returns it, if it exists.
	 * @param fileName name of the file (relative name to the given folder)
	 * @param folderName name of the folder in which the file is.
	 * @param withoutExtension indicates whether to compare with the file extension or not. false means, the extension will be compared, too.
	 * @return the right reference to the file or null if not found
	 */
	public Reference findReferenceByFileNameAndFolder(String fileName, String folderName, boolean withoutExtension){
		Reference[] refs = this.findReferencesByFolderName(folderName);
		for(Reference ref: refs){
			String file = ref.fileName.replaceAll(folderName+"/", "");
			if(withoutExtension) file = file.replaceAll(".png", "");
			if(file.equals(fileName)) return ref;
		}
		return null;
	}
}