FuseType.java

/*******************************************************************************
 * Copyright (c) 2008, 2011 Thomas Holland (thomas@innot.de) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Thomas Holland - initial API and implementation
 *******************************************************************************/
package de.innot.avreclipse.core.toolinfo.fuses;

/**
 * Enumeration of fuse type memories.
 * <p>
 * Currently fuse bytes {@link #FUSE} and lockbits bytes {@link #LOCKBITS} are supported, however
 * more enumeration values could be added to support e.g. calibration bytes.
 * </p>
 * <p>
 * This enum is used throughout the AVR Eclipse plugin to differentiate between fuses and lockbits
 * which are almost the same from the plugin perspective.
 * </p>
 * 
 * @see ByteValues
 * @see ByteDescription
 * 
 * @author Thomas Holland
 * @since 2.3
 * 
 */
public enum FuseType {

	/** Fuse byte type */
	FUSE("Fuse", "fusebyte", "FUSE", "fuses", 6),

	/** Lockbits byte type */
	LOCKBITS("Lockbits", "lockbitsbyte", "LOCKBIT", "locks", 1);

	private final String	fName;
	private final String	fElementName;
	private final String	fMemspaceName;
	private final String	fExtension;
	private final int		fMaxBytes;

	private FuseType(String stringname, String elementname, String memspacename, String extension,
			int maxbytes) {
		fName = stringname;
		fElementName = elementname;
		fMemspaceName = memspacename;
		fExtension = extension;
		fMaxBytes = maxbytes;
	}

	/**
	 * Get the xml element tag name for the fuse memory type.
	 * 
	 * @return XML tag name used in the *.desc files.
	 */
	public String getElementName() {
		return fElementName;
	}

	/**
	 * Get the name used in the "memspace" attribute in the part description file.
	 * <p>
	 * Currently this method will return either "FUSE" or "LOCKBIT".
	 * </p>
	 * 
	 * @return
	 */
	public String getMemspaceName() {
		return fMemspaceName;
	}

	/**
	 * Get the file extension used for files of this type.
	 * 
	 * @return The extension String without the leading dot.
	 */
	public String getExtension() {
		return fExtension;
	}

	/**
	 * Get the <code>FuseType</code> for a given extension.
	 * 
	 * @param extension
	 *            <code>String</code> without the leading dot, e.g. "fuses".
	 * @return The matching <code>FuseType</code> or <code>null</code> if no match.
	 */
	public static FuseType getTypeFromExtension(String extension) {

		for (FuseType type : FuseType.values()) {
			if (type.fExtension.equalsIgnoreCase(extension)) {
				return type;
			}
		}

		return null;
	}

	/**
	 * Convert a memspace attribute from the part description file to a FuseType enum value.
	 * 
	 * @param memspace
	 *            A <code>String</code> with the text content of the memspace attribute.
	 * @return
	 */
	public static FuseType getTypeFromPDFmemspace(String memspace) {
		if ("FUSE".equalsIgnoreCase(memspace)) {
			return FuseType.FUSE;
		} else if ("LOCKBIT".equalsIgnoreCase(memspace)) {
			return FuseType.LOCKBITS;
		} else {
			// add other types as when they are become supported
		}

		return null;
	}

	/**
	 * Gets the maximum number of bytes this type of fuse memory can support.
	 * <p>
	 * This method is deprecated because all code should dynamically determine the number of fuse
	 * bytes for the current MCU instead of using this static reference which might not be enough
	 * for future MCUs.
	 * </p>
	 * 
	 * @return <code>6</code> for Fuse memory and <code>1</code> for Lockbit memory.
	 */
	// @Deprecated
	public int getMaxBytes() {
		return fMaxBytes;
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Enum#toString()
	 */
	@Override
	public String toString() {
		// Return the type name in mixed case (instead of the uppercase values from the default Enum
		// implementation).
		return fName;
	}

}