net.jqhome.jwps.ea.standard
Class HistoryEA

java.lang.Object
  |
  +--net.jqhome.jwps.ea.AbstractEA
        |
        +--net.jqhome.jwps.ea.EAVector
              |
              +--net.jqhome.jwps.ea.MVMTEA
                    |
                    +--net.jqhome.jwps.ea.StringMVMT
                          |
                          +--net.jqhome.jwps.ea.standard.HistoryEA

public class HistoryEA

extends StringMVMT

This EA is for managing a history or list of things done to/with the file. The system does not process or use this in any way, it is just defined as a programmer convenience.

The format that the developer's guide gives for the history field is

person-name action date

the actions are restricted to being one of the words CREATED, CHANGED or PRINTED so for example

Bob CHANGED 4/11/89

This looks really groovy, in a 1960's mainframe way, but is not really useful (Bob who? the guy in the mailroom or the front desk?). Remember that this EA was first introduced in the late 1980's with OS/2. Fortunately, this is really just a set of string EAs so you can roll your own as needed.

Nested Class Summary

Nested classes inherited from class net.jqhome.jwps.ea.MVMTEA

MVMTEA.FoundEA

Field Summary

Fields inherited from class net.jqhome.jwps.ea.EAVector

EA_CODEPAGE_INDEX, EA_COUNT_INDEX, EA_TYPE_INDEX, MVMT_DATA_CONTROL_BLOCK_LENGTH, MVMT_DATA_LENGTH_OFFSET, MVMT_DATA_OFFSET, MVMT_DATA_START_INDEX, MVMT_DATA_TYPE_OFFSET, MVST_DATA_CONTROL_BLOCK_LENGTH, MVST_DATA_LENGTH_OFFSET, MVST_DATA_OFFSET, MVST_DATA_START_INDEX, MVST_TYPE_INDEX

Fields inherited from class net.jqhome.jwps.ea.AbstractEA

EA_NAME_ASSOCIATION_TABLE, EA_NAME_CODEPAGE, EA_NAME_COMMENTS, EA_NAME_HISTORY, EA_NAME_ICON, EA_NAME_ICON1, EA_NAME_KEYPHRASES, EA_NAME_LONGNAME, EA_NAME_SUBJECT, EA_NAME_TYPE, EA_NAME_VERSION, XML_EA_B64_ENCODING, XML_EA_CODEPAGE_TAGNAME, XML_EA_ENCODING_TYPE_TAGNAME, XML_EA_FILE_TAGNAME, XML_EA_IS_CRITICAL_TAGNAME, XML_EA_LIST_TAGNAME, XML_EA_NAME_TAGNAME, XML_EA_TAGNAME, XML_EA_TEXT_ENCODING, XML_EA_TYPE_TAGNAME, XML_EA_VALUE_TAGNAME

Constructor Summary

HistoryEA()

HistoryEA(RawEA rEA)

Method Summary

boolean	isCritical() Returns if this EA is marked as critical.
void	setCritical(boolean value)

Methods inherited from class net.jqhome.jwps.ea.StringMVMT

addEA, getStringEAAt, removeStringEA, removeStringEA

Methods inherited from class net.jqhome.jwps.ea.MVMTEA

fromRawEA, getEA, getEntryType, getMVEA2, getMVMTCount, getRawEASize, getSTEntryLength, getSVEA2, mvmtSetup, toRawEA, toString, valueSize

Methods inherited from class net.jqhome.jwps.ea.EAVector

addEA, addEA, equals, getCodepage, getEAAt, getEACodepage, getEACount, getEAType, getVector, isDefaultCodepage, removeEAAt, setCodepage, size, toXML

Methods inherited from class net.jqhome.jwps.ea.AbstractEA

fileToBytes, getName, getType, isUserDefined, setName, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryEA

public HistoryEA()
          throws JWPException

HistoryEA

public HistoryEA(RawEA rEA)
          throws JWPException

Method Detail

isCritical

public boolean isCritical()

Description copied from class: AbstractEA

Returns if this EA is marked as critical. Note that critical here means that the applications that use this EA will not be able to function without it. Yes, you can edit or delete them as you like. All that this means is that some application needs it. The honor system is in effect to leave other applications EAs alone especially if they are critical.

Overrides:

isCritical in class AbstractEA

setCritical

public void setCritical(boolean value)
                 throws JWPException

Overrides:

setCritical in class AbstractEA

Throws:

JWPException - if an attempt is made to set the value to anything but false since this EA is not critical.