net.bitform.api.options

Class TargetOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.TargetOption

All Implemented Interfaces:

Option

Direct Known Subclasses:

AnalyzeOption, ScrubOption

public abstract class TargetOption
extends BasicOption

An option that represents a feature or part of a file format that can be acted on. Since not all file formats contain the same parts this class extends BasicOption to add an association between the option and a specifc set of file formats.

The following code can be used to construct a complete description for a specific TargetOption.

 public String getCompleteDescription(TargetOption option) {

    StringBuffer buf = new StringBuffer();
    buf.append(option.getName())
    buf.append("\n\n");
    buf.append(option.getLongDescription());

    TargetOption.FormatInformation[] formats = option.appliesTo();

    for (int i = 0; i < formats.length; i++) {
        if (formats[i].getDescription() != "") {
            buf.append("\n\n");
            buf.append(formats[i].getDescription());
        }
    }

    buf.append("\n\nApplies to:\n");

    for (int i = 0; i < formats.length; i++) {
        buf.append(formats[i].getFormat().getName());
        buf.append("\n");
    }

    return buf.toString();
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TargetOption.FormatInformation Combination of a file format and a description that is associated with a specific TargetOption.

Method Summary

Modifier and Type	Method and Description
TargetOption.FormatInformation[]	appliesTo() Returns the list of file formats this option applies to.
TargetOption	getParent() Returns the parent Target of this Target.

Methods inherited from class net.bitform.api.options.BasicOption

getId, getLongDescription, getName, getShortDescription, getUid, isRequest, isResponse, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

appliesTo

public TargetOption.FormatInformation[] appliesTo()

Returns the list of file formats this option applies to. The returned FormatInformation objects also include a description of how the option applies to that specific format.

Returns:

List of file formats this options applies to.

getParent

public TargetOption getParent()

Returns the parent Target of this Target.

Returns:

The parent Target or null if the Target is at the top level