org.acm.seguin.pretty
Class SpecialTokenData

java.lang.Object
  extended by org.acm.seguin.pretty.SpecialTokenData

public class SpecialTokenData
extends java.lang.Object

Store the data that understands how to output comments and newlines

Author:
Chris Seguin, Mike Atkinson

Constructor Summary
SpecialTokenData(JavaDocable jdi, net.sourceforge.jrefactory.parser.Token token, PrintData printData)
          Creates a special token data object
SpecialTokenData(JavaDocable jdi, net.sourceforge.jrefactory.parser.Token token, PrintData printData, boolean accept)
          Creates a special token data object
SpecialTokenData(net.sourceforge.jrefactory.parser.Token token, PrintData printData)
          Creates a special token data object
SpecialTokenData(net.sourceforge.jrefactory.parser.Token token, PrintData printData, boolean accept)
          Creates a special token data object
 
Method Summary
 net.sourceforge.jrefactory.parser.Token beginning(net.sourceforge.jrefactory.parser.Token tok)
          Got to the beginning
 void convertFirstCStyleCommentToSingleLine()
          If the first special Token is a C_STYLE_COMMENT, then pretend it is a SINGLE_LINE_COMMENT.
 JavaDocable getJDI()
           
 PrintData getPrintData()
          Return the print data
 net.sourceforge.jrefactory.parser.Token getSpecialToken()
          Return the special token
 java.lang.String getTokenImage()
          Get the token image
 int getTokenType()
          Get the token type
 boolean isAcceptingReturns()
          Return true if new lines should be accepted
 boolean isFirst()
          Returns true when it is the first
 boolean isLast()
          Returns true when it is the last
 boolean isLastJavadocComment()
          Returns true when it is the last JavaDoc comment.
 boolean isReformattingComments()
          Returns true if comments are being reformatted
 boolean isReturnExpected()
          Return true if the last return was expected
 void next()
          Get the next token
 void setReturnExpected(boolean way)
          Set that the last return was (or not) expected
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpecialTokenData

public SpecialTokenData(JavaDocable jdi,
                        net.sourceforge.jrefactory.parser.Token token,
                        PrintData printData)
Creates a special token data object

Parameters:
token - the special token
printData - the print data

SpecialTokenData

public SpecialTokenData(net.sourceforge.jrefactory.parser.Token token,
                        PrintData printData)
Creates a special token data object

Parameters:
token - the special token
printData - the print data

SpecialTokenData

public SpecialTokenData(net.sourceforge.jrefactory.parser.Token token,
                        PrintData printData,
                        boolean accept)
Creates a special token data object

Parameters:
token - the special token
printData - the print data
accept - whether newlines should be accepted

SpecialTokenData

public SpecialTokenData(JavaDocable jdi,
                        net.sourceforge.jrefactory.parser.Token token,
                        PrintData printData,
                        boolean accept)
Creates a special token data object

Parameters:
token - the special token
printData - the print data
accept - whether newlines should be accepted
Method Detail

setReturnExpected

public void setReturnExpected(boolean way)
Set that the last return was (or not) expected

Parameters:
way - the way it was expected

isLast

public boolean isLast()
Returns true when it is the last

Returns:
true if we are at the last

isLastJavadocComment

public boolean isLastJavadocComment()
Returns true when it is the last JavaDoc comment.

Returns:
true if we are the last
Since:
JRefactory 2.7.00

convertFirstCStyleCommentToSingleLine

public void convertFirstCStyleCommentToSingleLine()
If the first special Token is a C_STYLE_COMMENT, then pretend it is a SINGLE_LINE_COMMENT. Fixes bug 761890 (at least partly).

Since:
JRefactory 2.7.03

isFirst

public boolean isFirst()
Returns true when it is the first

Returns:
true if we are at the first

getPrintData

public PrintData getPrintData()
Return the print data

Returns:
the print data object

getSpecialToken

public net.sourceforge.jrefactory.parser.Token getSpecialToken()
Return the special token

Returns:
the special token

getJDI

public JavaDocable getJDI()

getTokenType

public int getTokenType()
Get the token type

Returns:
the token type

getTokenImage

public java.lang.String getTokenImage()
Get the token image

Returns:
the token image

isReturnExpected

public boolean isReturnExpected()
Return true if the last return was expected

Returns:
true if last was expected

isAcceptingReturns

public boolean isAcceptingReturns()
Return true if new lines should be accepted

Returns:
true if newlines should be accepted

isReformattingComments

public boolean isReformattingComments()
Returns true if comments are being reformatted

Returns:
true if comments should be reformatted

beginning

public net.sourceforge.jrefactory.parser.Token beginning(net.sourceforge.jrefactory.parser.Token tok)
Got to the beginning

Parameters:
tok - Description of Parameter
Returns:
Description of the Returned Value

next

public void next()
Get the next token