emulib.plugins.compiler

Class SourceFileExtension

java.lang.Object

emulib.plugins.compiler.SourceFileExtension

public class SourceFileExtension
extends Object

This class is a container that holds a single file extension and its description for source file that is supported for the compiler. The file extension should have the form without the starting dot ("."), i.e. "asm" instead of ".asm". The extension will be taken in case insensitive manner. The description of the extension should be in any form. Immutable object.

Constructor Summary

Constructors

Constructor and Description
SourceFileExtension(String extension, String description) Creates an instance of the class.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return raw file-extension description as it was passed.
String	getExtension() Return the file extension.
String	getFormattedDescription() This method returns the formatted file-extension description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceFileExtension

public SourceFileExtension(String extension,
                           String description)

Creates an instance of the class.

Parameters:

extension - Case insensitive file extension of the file, without the starting dot (example: "asm", but not ".asm").

description - The description of the file extension.

Method Detail

getExtension

public String getExtension()

Return the file extension.

Returns:

File extension

getDescription

public String getDescription()

Return raw file-extension description as it was passed.

Returns:

file-extension description

getFormattedDescription

public String getFormattedDescription()

This method returns the formatted file-extension description. The formatting represents combining the raw description with the file extension, enclosed in brackets. For example, if the raw description was "Assembler source" and the extension "asm", then the formatted description will be: "Assembler source (*.asm)"

Returns:

formatted file-extension description