ExtensionDescriptor

java.lang.Object
- casa.extensions.ExtensionDescriptor

All Implemented Interfaces:

Comparable<ExtensionDescriptor>
```
public class ExtensionDescriptor
extends Object
implements Comparable<ExtensionDescriptor>
```
Title: CASA Agent Infrastructure

Copyright: Copyright (c) 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Company: Knowledge Science Group, Department of Computer Science, University of Calgary
A simple and generic description if a CASA extension (plug-in).

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Map<String,Object>`	`attributes` The attributes of the extension.
`(package private) Integer`	`index` The index of the extension (largely irrelivant -- suffixed number used in the names of jar sections).
`(package private) File`	`sourceFile` the source file were the exension resides in,
`(package private) String`	`type` the type (code, tab, or Lisp-Script) of the extension.

Constructor Summary

Constructors
Constructor and Description
`ExtensionDescriptor(String type, File sourceFile, Integer index, Attributes attrs, String defaultMain)` Defers to `ExtensionDescriptor(String, File, Integer, Map, String)` by transforming the forth parameter.
`ExtensionDescriptor(String type, File sourceFile, Integer index, Map<String,Object> attrs, String defaultMain)` Builds a new ExtensionDescriptor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static Map<String,Object>`	`attributes2Map(Attributes attrs)`
`int`	`compareTo(ExtensionDescriptor o)` Compares on the basis of type sourceFilename (existing or not existing and both existing) index
`Object`	`get(String key)` Retrieves the value for key in the attribute list or null if there is not key in the attribute list.
`int`	`getIndex()`
`File`	`getSourceFile()`
`String`	`getType()`
`private String`	`makeValueString(Object val)`
`(package private) void`	`put(String key, Object o)` Adds a new attribute key with value o.
`(package private) void`	`remove(String key)` Removes a key/value pair from the attribues list.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
String type
```
    the type (code, tab, or Lisp-Script) of the extension.
  - sourceFile
```
File sourceFile
```
    the source file were the exension resides in,
  - attributes
```
Map<String,Object> attributes
```
    The attributes of the extension. All keys are stored as lower case for case-insensitivity.
  - index
```
Integer index
```
    The index of the extension (largely irrelivant -- suffixed number used in the names of jar sections).
- Constructor Detail
  - ExtensionDescriptor
```
public ExtensionDescriptor(String type,
                           File sourceFile,
                           Integer index,
                           Attributes attrs,
                           String defaultMain)
```
    Defers to ExtensionDescriptor(String, File, Integer, Map, String) by transforming the forth parameter.
    
    Parameters:
    
    type - The type of the extension (code, tab, Lisp_Script).
    
    sourceFile - The file in which the extension resides.
    
    index - The index of the extension (largely irrelivant -- suffixed number used in the names of jar sections).
    
    attrs - The attributes of the extension.
    
    defaultMain - The main class named in the main section of the manifest of a jar file. May be null.
  - ExtensionDescriptor
```
public ExtensionDescriptor(String type,
                           File sourceFile,
                           Integer index,
                           Map<String,Object> attrs,
                           String defaultMain)
```
    Builds a new ExtensionDescriptor.
    
    Parameters:
    
    type - The type of the extension (code, tab, Lisp_Script).
    
    sourceFile - The file in which the extension resides.
    
    index - The index of the extension (largely irrelivant -- suffixed number used in the names of jar sections).
    
    attrs - The attributes of the extension.
    
    defaultMain - The main class named in the main section of the manifest of a jar file. May be null.
- Method Detail
  - attributes2Map
```
private static Map<String,Object> attributes2Map(Attributes attrs)
```
  - put
```
void put(String key,
         Object o)
```
    Adds a new attribute key with value o. Not that the key will be converted to lower case before saving.
    
    Parameters:
    
    key - The key to the newly added key/value pair.
    
    o - The value to the newly added key/value pair.
  - remove
```
void remove(String key)
```
    Removes a key/value pair from the attribues list. Not that the key is NOT case-senstive.
    
    Parameters:
    
    key - The key of the key/value pair in the attributes list.
  - get
```
public Object get(String key)
```
    Retrieves the value for key in the attribute list or null if there is not key in the attribute list. Not that the key is NOT case-senstive.
    
    Parameters:
    
    key - The key of the key/value pair in the attributes list.
    
    Returns:
    
    The value for key, or null if the key is not in the attribute list.
  - getSourceFile
```
public File getSourceFile()
```
    Returns:
    
    the source file for this extension as per the constructor.
  - getType
```
public String getType()
```
    Returns:
    
    the type (code, tab, Lisp-Script) for this extension as per the constructor.
  - getIndex
```
public int getIndex()
```
    Returns:
    
    the index for this extension as per the constructor.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of the object in Lisp notation:
    (extension-descriptor [type] {:[key] [value]}* {:sourcefile [filename]})
  - makeValueString
```
private String makeValueString(Object val)
```
  - compareTo
```
public int compareTo(ExtensionDescriptor o)
```
    Compares on the basis of
    1. type
    2. sourceFilename (existing or not existing and both existing)
    3. index
    Specified by:
    
    compareTo in interface Comparable<ExtensionDescriptor>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)

Class ExtensionDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

sourceFile

attributes

index

Constructor Detail

ExtensionDescriptor

ExtensionDescriptor

Method Detail

attributes2Map

put

remove

get

getSourceFile

getType

getIndex

toString

makeValueString

compareTo