com.brashmonkey.spriter.Folder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of overlap2d-runtime-libgdx Show documentation

overlap2d-runtime-libgdx provides functionality to load, manipulate and render scenes generated by Overlap2D.

The newest version!

package com.brashmonkey.spriter;

/**
 * Represents a folder in a Spriter SCML file.
 * A folder has at least an {@link #id}, {@link #name} and {@link #files} may be empty.
 * An instance of this class holds an array of {@link File} instances.
 * Specific {@link File} instances can be accessed via the corresponding methods, i.e getFile().
 * @author Trixt0r
 *
 */
public class Folder {

    final File[] files;
    private int filePointer = 0;
    public final int id;
    public final String name;
    
    Folder(int id, String name, int files){
    	this.id = id;
    	this.name = name;
    	this.files = new File[files];
    }
    
    /**
     * Adds a {@link File} instance to this folder.
     * @param file the file to add
     */
    void addFile(File file){
    	this.files[filePointer++] = file;
    }
    
    /**
     * Returns a {@link File} instance with the given index.
     * @param index the index of the file
     * @return the file with the given name
     */
    public File getFile(int index){
    	return files[index];
    }
    
    /**
     * Returns a {@link File} instance with the given name.
     * @param name the name of the file
     * @return the file with the given name or null if no file with the given name exists
     */
    public File getFile(String name){
    	int index = getFileIndex(name);
    	if(index >= 0) return getFile(index);
    	else return null;
    }
    
    /**
     * Returns a file index with the given name.
     * @param name the name of the file
     * @return the file index with the given name or -1 if no file with the given name exists
     */
    int getFileIndex(String name){
    	for(File file: this.files)
    		if(file.name.equals(name)) return file.id;
    	return -1;
    }
    
    public String toString(){
    	String toReturn = getClass().getSimpleName()+"|[id: "+id+", name: "+name;
    	for(File file: files)
    		toReturn += "\n"+file;
    	toReturn += "]";
    	return toReturn;
    }
}