Java Doc for Environment.java in » Code-Analyzer » Spoon » spoon » processing » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Code Analyzer » Spoon » spoon.processing

Source Cross Reference

Class Diagram

Java Document (Java Doc)

spoon.processing .Environment

All known Subclasses:   spoon.support .StandardEnvironment,
Environment
public interface Environment extends FactoryAccessor(Code)
This interface represents the environment in which Spoon is launched - accessible through spoon.reflect.Factory.getEnvironment . Its primary use is to report messages, warnings, and errors.

Method Summary
public void debugMessage(String message)
     This method should be called to print out a message with a source position link during the processing.
public int getComplianceLevel()
     Gets the Java version compliance level.
public FileGenerator<? extends CtElement> getDefaultFileGenerator()
     Returns the default file generator for this environment (gives the default output directory for the created files).
ProcessingManager getManager()
     Gets the processing manager.
ProcessorProperties getProcessorProperties(String processorName)
     Returns the properties for a given processor.
String getSourcePath()

int getTabulationSize()
     Gets the size of the tabulations in the generated source code.
public boolean isDebug()
     Returns true if Spoon is in debug mode.
public boolean isProcessingStopped()
     Tells if the processing is stopped, generally because one of the processors called Environment.setProcessingStopped(boolean) after reporting an error.
boolean isUsingSourceCodeFragments()
     Tells if the code generation use code fragments.
boolean isUsingTabulations()
     Tells if Spoon uses tabulations in the source code.
public boolean isVerbose()
     Returns true if Spoon is in verbose mode.
public void report(Processor processor, Severity severity, CtElement element, String message)
     Helper method called by a processor to report an error, warning or message as dictated by the severity parameter.
public void report(Processor processor, Severity severity, CtElement element, String message, ProblemFixer... fixes)
     Helper method called by a processor to report an error, warning or message as dictated by the severity parameter.
public void report(Processor processor, Severity severity, String message)
     This method should be called to print out a message during the processing.
Parameters:
  processor - The processor that report this message.
public void reportEnd()
     This method should be called to report the end of the processing.
public void reportProgressMessage(String message)
     This method should be called to print out a progress message during the processing.
public void setComplianceLevel(int level)
     Sets the Java version compliance level.
public void setDebug(boolean debug)
     Sets the debug mode.
void setDefaultFileGenerator(FileGenerator<? extends CtElement> generator)
     Sets the default file generator for this environment.
void setManager(ProcessingManager manager)
     Sets the processing manager of this environment.
void setProcessingStopped(boolean processingStopped)
     This method can be called to stop the processing and all the remaining tasks.
void setProcessorProperties(String processorName, ProcessorProperties prop)
     Sets the properties for a given processor.
void setTabulationSize(int size)
     Sets the size of the tabulations in the generated source code.
void setVerbose(boolean verbose)
     Sets/unsets the verbose mode.
void useSourceCodeFragments(boolean b)
     Sets the code generation to use code fragments.
void useTabulations(boolean b)
     Sets Spoon to use tabulations in the source code.

Method Detail
debugMessage
public void debugMessage(String message)(Code)
This method should be called to print out a message with a source position link during the processing.

getComplianceLevel
public int getComplianceLevel()(Code)
Gets the Java version compliance level.

getDefaultFileGenerator
public FileGenerator<? extends CtElement> getDefaultFileGenerator()(Code)
Returns the default file generator for this environment (gives the default output directory for the created files).

getManager
ProcessingManager getManager()(Code)
Gets the processing manager.

getProcessorProperties
ProcessorProperties getProcessorProperties(String processorName) throws Exception(Code)
Returns the properties for a given processor.

getSourcePath
String getSourcePath()(Code)
Gets the current input path

getTabulationSize
int getTabulationSize()(Code)
Gets the size of the tabulations in the generated source code.

isDebug
public boolean isDebug()(Code)
Returns true if Spoon is in debug mode.

isProcessingStopped
public boolean isProcessingStopped()(Code)
Tells if the processing is stopped, generally because one of the processors called Environment.setProcessingStopped(boolean) after reporting an error.

isUsingSourceCodeFragments
boolean isUsingSourceCodeFragments()(Code)
Tells if the code generation use code fragments.

isUsingTabulations
boolean isUsingTabulations()(Code)
Tells if Spoon uses tabulations in the source code.

isVerbose
public boolean isVerbose()(Code)
Returns true if Spoon is in verbose mode.

report
public void report(Processor processor, Severity severity, CtElement element, String message)(Code)
Helper method called by a processor to report an error, warning or message as dictated by the severity parameter. Note that this does not stop the processing or any remaing task. To do so, use Environment.setProcessingStopped(boolean) .
Parameters:
  processor - The processor that report this message. Can be null.
Parameters:
  severity - The severity of the report
Parameters:
  element - The CtElement to which the report is associated
Parameters:
  message - The message to report

report
public void report(Processor processor, Severity severity, CtElement element, String message, ProblemFixer... fixes)(Code)
Helper method called by a processor to report an error, warning or message as dictated by the severity parameter. Note that this does not stop the processing or any remaining task. To do so, use Environment.setProcessingStopped(boolean) .
Parameters:
  processor - The processor that report this message. Can be null.
Parameters:
  severity - The severity of the report
Parameters:
  element - The CtElement to which the report is associated
Parameters:
  message - The message to report
Parameters:
  fixes - The problem fixer(s) to correct this problem

report
public void report(Processor processor, Severity severity, String message)(Code)
This method should be called to print out a message during the processing.
Parameters:
  processor - The processor that report this message. Can be null.
Parameters:
  severity - The severity of the report
Parameters:
  message - The message to report

reportEnd
public void reportEnd()(Code)
This method should be called to report the end of the processing.

reportProgressMessage
public void reportProgressMessage(String message)(Code)
This method should be called to print out a progress message during the processing. On contrary to regular messages, progress messages are not meant to remain in the message logs and just indicate to the user some task progression information.

setComplianceLevel
public void setComplianceLevel(int level)(Code)
Sets the Java version compliance level.

setDebug
public void setDebug(boolean debug)(Code)
Sets the debug mode.

setDefaultFileGenerator
void setDefaultFileGenerator(FileGenerator<? extends CtElement> generator)(Code)
Sets the default file generator for this environment.

setManager
void setManager(ProcessingManager manager)(Code)
Sets the processing manager of this environment.

setProcessingStopped
void setProcessingStopped(boolean processingStopped)(Code)
This method can be called to stop the processing and all the remaining tasks. In general, a processor calls it after reporting a fatal error.

setProcessorProperties
void setProcessorProperties(String processorName, ProcessorProperties prop)(Code)
Sets the properties for a given processor.

setTabulationSize
void setTabulationSize(int size)(Code)
Sets the size of the tabulations in the generated source code.

setVerbose
void setVerbose(boolean verbose)(Code)
Sets/unsets the verbose mode.

useSourceCodeFragments
void useSourceCodeFragments(boolean b)(Code)
Sets the code generation to use code fragments.

useTabulations
void useTabulations(boolean b)(Code)
Sets Spoon to use tabulations in the source code.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.