Package jmri.implementation

Class PermissionProgrammer

java.lang.Object

jmri.implementation.PermissionProgrammer

All Implemented Interfaces:

Disposable, Programmer

Direct Known Subclasses:

PermissionAddressedProgrammer

public class PermissionProgrammer
extends java.lang.Object
implements Programmer

A programmer which supports permissions.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
protected Programmer	_programmer

Constructor Summary

Constructors

Constructor	Description
PermissionProgrammer(Programmer programmer)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener p)
void	confirmCV(java.lang.String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
java.lang.String	decodeErrorCode(int i)
boolean	getCanRead()	Checks the general read capability, regardless of mode
boolean	getCanRead(java.lang.String addr)	Checks the general read capability, regardless of mode, for a specific address
boolean	getCanWrite()	Checks the general write capability, regardless of mode
boolean	getCanWrite(java.lang.String addr)	Checks the general write capability, regardless of mode, for a specific address
Programmer.Configurator	getConfigurator()	Get the configurator of this programmer.
ProgrammingMode	getMode()	Get the current programming mode
protected Permission	getPermission()
java.util.List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
Programmer.WriteConfirmMode	getWriteConfirmMode(java.lang.String addr)	Learn about whether the programmer does any kind of verification of write operations
void	readCV(java.lang.String CV, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	readCV(java.lang.String CVname, ProgListener p, int startVal)	Perform a CV read in the system-specific manner, and using the specified programming mode, possibly using a hint of the current value to speed up programming.
void	removePropertyChangeListener(java.beans.PropertyChangeListener p)
void	setMode(ProgrammingMode p)	Set the programmer to a particular mode.
protected boolean	throttleUserRequest()
void	writeCV(java.lang.String CV, int val, ProgListener p)	Perform a CV write in the system-specific manner, and using the specified programming mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Programmer

dispose, notifyProgListenerEnd

Field Detail

_programmer

protected final Programmer _programmer

Constructor Detail

PermissionProgrammer

public PermissionProgrammer(Programmer programmer)

Method Detail

throttleUserRequest

protected boolean throttleUserRequest()

getPermission

protected Permission getPermission()

writeCV

public void writeCV(java.lang.String CV,
                    int val,
                    ProgListener p)
             throws ProgrammerException

Perform a CV write in the system-specific manner, and using the specified programming mode.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

Specified by:

writeCV in interface Programmer

Parameters:

CV - the CV to write

val - the value to write

p - the listener that will be notified of the write

Throws:

ProgrammerException - if unable to communicate

readCV

public void readCV(java.lang.String CV,
                   ProgListener p)
            throws ProgrammerException

Perform a CV read in the system-specific manner, and using the specified programming mode.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

Specified by:

readCV in interface Programmer

Parameters:

CV - the CV to read

p - the listener that will be notified of the read

Throws:

ProgrammerException - if unable to communicate

readCV

public void readCV(java.lang.String CVname,
                   ProgListener p,
                   int startVal)
            throws ProgrammerException

Perform a CV read in the system-specific manner, and using the specified programming mode, possibly using a hint of the current value to speed up programming.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

On systems that support it, the startVal is a hint as to what the current value of the CV might be (e.g. the value from the roster). This could be verified immediately in direct byte mode to speed up the read process.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Defaults to the normal read method if not overridden in a specific implementation.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

Specified by:

readCV in interface Programmer

Parameters:

CVname - the CV to read

p - the listener that will be notified of the read

startVal - a hint of what the current value might be, or 0

Throws:

ProgrammerException - if unable to communicate

confirmCV

public void confirmCV(java.lang.String CV,
                      int val,
                      ProgListener p)
               throws ProgrammerException

Confirm the value of a CV using the specified programming mode. On some systems, this is faster than a read.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

Specified by:

confirmCV in interface Programmer

Parameters:

CV - the CV to confirm

val - the value to confirm

p - the listener that will be notified of the confirmation

Throws:

ProgrammerException - if unable to communicate

getSupportedModes

public java.util.List<ProgrammingMode> getSupportedModes()

Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better.

Specified by:

getSupportedModes in interface Programmer

Returns:

the list of supported modes or an empty list

setMode

public void setMode(ProgrammingMode p)

Set the programmer to a particular mode.

Mode is a bound parameter; mode changes fire listeners.

Only modes returned by Programmer.getSupportedModes() are supported. If an invalid mode is requested, the active mode is unchanged.

Specified by:

setMode in interface Programmer

Parameters:

p - a valid node returned by Programmer.getSupportedModes() or null; null is ignored if Programmer.getSupportedModes() is not empty

getMode

public ProgrammingMode getMode()

Get the current programming mode

Specified by:

getMode in interface Programmer

Returns:

the current mode or null if none is defined and no default mode is defined

getCanRead

public boolean getCanRead()

Checks the general read capability, regardless of mode

Specified by:

getCanRead in interface Programmer

Returns:

true if the programmer is capable of reading; false otherwise

getCanRead

public boolean getCanRead(java.lang.String addr)

Checks the general read capability, regardless of mode, for a specific address

Specified by:

getCanRead in interface Programmer

Parameters:

addr - the address to read

Returns:

true if the address can be read; false otherwise

getCanWrite

public boolean getCanWrite()

Checks the general write capability, regardless of mode

Specified by:

getCanWrite in interface Programmer

Returns:

true if the programmer is capable of writing; false otherwise

getCanWrite

public boolean getCanWrite(java.lang.String addr)

Checks the general write capability, regardless of mode, for a specific address

Specified by:

getCanWrite in interface Programmer

Parameters:

addr - the address to write to

Returns:

true if the address can be written to; false otherwise

getWriteConfirmMode

public Programmer.WriteConfirmMode getWriteConfirmMode(java.lang.String addr)

Learn about whether the programmer does any kind of verification of write operations

Specified by:

getWriteConfirmMode in interface Programmer

Parameters:

addr - A CV address to check (in case this varies with CV range) or null for any

Returns:

The confirmation behavior that can be counted on (might be better in some cases)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener p)

Specified by:

addPropertyChangeListener in interface Programmer

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener p)

Specified by:

removePropertyChangeListener in interface Programmer

decodeErrorCode

public java.lang.String decodeErrorCode(int i)

Specified by:

decodeErrorCode in interface Programmer

getConfigurator

public Programmer.Configurator getConfigurator()

Get the configurator of this programmer.

Specified by:

getConfigurator in interface Programmer

Returns:

the configurator if it exists, otherwise null