com.canto.cumulus.prefs

Class AssetFormatsList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.AssetFormatsList

public class AssetFormatsList
extends ListPackManager

This class manages the formats list of an asset handling set.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AssetFormatsList.Entry This class describes one entry of an AssetFormatsList.

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	append(FormatListModuleEntry moduleEntry) Appends the given module entry to the end of the format list if the entry has not been added before.
java.lang.Object	clone() Clones this instance.
void	delete(FormatListModuleEntry moduleEntry) Deletes the given module entry.
java.util.List<FormatListModuleEntry>	getEntries() Returns a list of all module entries of this formats list
java.util.List<AssetFormatsList.Entry>	getEntryDescriptors() Returns a list of descriptors for the entries of the format list.
FormatListModuleEntry	getModuleEntry(java.lang.String uid, java.lang.String fileFormatName) Deprecated. Use getModuleEntry(String, String, String) instead
FormatListModuleEntry	getModuleEntry(java.lang.String uid, java.lang.String fileFormatExtension, java.lang.String macFileType) Returns the module entry for the specified module UID, format extension and Mac file type.
void	moveDown(FormatListModuleEntry entry) Moves the given entry one position down.
void	moveDownToEnd(FormatListModuleEntry entry) Moves the given entry to the end of the list.
void	moveUp(FormatListModuleEntry entry) Moves the given entry one position up.
void	moveUpToTop(FormatListModuleEntry entry) Moves the given entry to the top.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

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

Method Detail

getEntryDescriptors

public java.util.List<AssetFormatsList.Entry> getEntryDescriptors()

Returns a list of descriptors for the entries of the format list.

Returns:

list of AssetFormatsList.Entry instances

getEntries

public java.util.List<FormatListModuleEntry> getEntries()

Returns a list of all module entries of this formats list

Returns:

list of FormatListModuleEntry instances

append

public boolean append(FormatListModuleEntry moduleEntry)

Appends the given module entry to the end of the format list if the entry has not been added before.

Parameters:

moduleEntry - the module entry to add

Returns:

true if the entry has been appended; false if the entry already was part of this formats list

getModuleEntry

@Deprecated
public FormatListModuleEntry getModuleEntry(java.lang.String uid,
                                              java.lang.String fileFormatName)

Deprecated. Use getModuleEntry(String, String, String) instead

Returns the module entry for the specified module UID and format name.

Parameters:

uid - the UID of the module entry

fileFormatName - the format name of the module entry

Returns:

the found module entry or null

getModuleEntry

public FormatListModuleEntry getModuleEntry(java.lang.String uid,
                                   java.lang.String fileFormatExtension,
                                   java.lang.String macFileType)

Returns the module entry for the specified module UID, format extension and Mac file type.

Parameters:

uid - the UID of the module entry

fileFormatExtension - the format extension of the module entry

macFileType - the Mac file type of the module entry

Returns:

the found module entry or null

Since:

10.2

delete

public void delete(FormatListModuleEntry moduleEntry)

Deletes the given module entry.

Parameters:

moduleEntry - the entry to delete

moveUp

public void moveUp(FormatListModuleEntry entry)
            throws JPack.NoSuchElementException

Moves the given entry one position up.

Parameters:

entry - the entry to move up

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveUpToTop

public void moveUpToTop(FormatListModuleEntry entry)
                 throws JPack.NoSuchElementException

Moves the given entry to the top.

Parameters:

entry - the entry to move to the top

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveDown

public void moveDown(FormatListModuleEntry entry)
              throws JPack.NoSuchElementException

Moves the given entry one position down.

Parameters:

entry - the entry to move down

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveDownToEnd

public void moveDownToEnd(FormatListModuleEntry entry)
                   throws JPack.NoSuchElementException

Moves the given entry to the end of the list.

Parameters:

entry - the entry to move to the end

Throws:

JPack.NoSuchElementException - in case of an invalid entry

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones this instance.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException