Package org.djutils.decoderdumper
Class FixedString
java.lang.Object
org.djutils.decoderdumper.FixedString
- All Implemented Interfaces:
Decoder
public class FixedString extends Object implements Decoder
Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
- Version:
- $Revision$, $LastChangedDate$, by $Author$, initial version Jan 3, 2019
- Author:
- Alexander Verbraeck, Peter Knoppers, Wouter Schakel
-
Constructor Summary
Constructors Constructor Description FixedString(String fixedResult)
Construct a Decoder that returns a fixed result in thegetResult
method. -
Method Summary
Modifier and Type Method Description boolean
append(int address, byte theByte)
Decode one (more) byte.int
getMaximumWidth()
Retrieve the maximum width (in characters) of results that this Decoder can return (all shorter results will be padded to this width with spaces, unless this is the last active Decoder).String
getResult()
Retrieve the current result of this Decoder.boolean
ignoreForIdenticalOutputCheck()
If the result of this Decoder should not be used to compare output lines for suppressing identical lines, this method should return true; otherwise it should return false.String
toString()
-
Constructor Details
-
FixedString
Construct a Decoder that returns a fixed result in thegetResult
method.- Parameters:
fixedResult
- String; the String that thegetResult
method will return on each invocation
-
-
Method Details
-
getResult
Retrieve the current result of this Decoder. Decoders that handle multiple byte input may be somewhere within a token. Such Decoders should report a partial result. If no data has been added, the result must be the empty string. -
getMaximumWidth
public int getMaximumWidth()Retrieve the maximum width (in characters) of results that this Decoder can return (all shorter results will be padded to this width with spaces, unless this is the last active Decoder).- Specified by:
getMaximumWidth
in interfaceDecoder
- Returns:
- int; the maximum width (in characters) of results that this Decoder can return
-
append
public boolean append(int address, byte theByte)Decode one (more) byte. This method must return true when a line becomes full due to this call, otherwise this method must return false.- Specified by:
append
in interfaceDecoder
- Parameters:
address
- int; the address that corresponds with the bytetheByte
- byte; the byte- Returns:
- boolean; true if an output line has been completed by this call; false if at least one more byte can be appended to the local accumulator before the current output line is full
-
ignoreForIdenticalOutputCheck
public boolean ignoreForIdenticalOutputCheck()If the result of this Decoder should not be used to compare output lines for suppressing identical lines, this method should return true; otherwise it should return false.- Specified by:
ignoreForIdenticalOutputCheck
in interfaceDecoder
- Returns:
- boolean; true if the result of this Decoder should be ignored in testing for identical output lines; otherwise false
-
toString
-