org.sonar.api.batch
Class AbstractViolationsStaxParser

java.lang.Object
  extended by org.sonar.api.batch.AbstractViolationsStaxParser

Deprecated. since 2.3. Too much "black-box".

@Deprecated
public abstract class AbstractViolationsStaxParser
extends Object

Since:
1.10

Field Summary
protected  SensorContext context
          Deprecated.  
protected  boolean doSaveViolationsOnUnexistedResource
          Deprecated.  
protected  RulesManager rulesManager
          Deprecated.  
 
Constructor Summary
protected AbstractViolationsStaxParser(SensorContext context, RulesManager rulesManager)
          Deprecated.  
protected AbstractViolationsStaxParser(SensorContext context, RulesManager rulesManager, RulesProfile profile)
          Deprecated. since 1.11.
 
Method Summary
protected abstract  org.codehaus.staxmate.in.SMInputCursor cursorForResources(org.codehaus.staxmate.in.SMInputCursor rootCursor)
          Deprecated. Cursor for child resources to parse, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs
protected abstract  org.codehaus.staxmate.in.SMInputCursor cursorForViolations(org.codehaus.staxmate.in.SMInputCursor resourcesCursor)
          Deprecated. Cursor for violations to parse for a given resource, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs
protected abstract  String keyForPlugin()
          Deprecated.  
protected abstract  String lineNumberForViolation(org.codehaus.staxmate.in.SMInputCursor violationCursor)
          Deprecated.  
protected abstract  String messageFor(org.codehaus.staxmate.in.SMInputCursor violationCursor)
          Deprecated.  
 void parse(File violationsXMLFile)
          Deprecated.  
 void parse(InputStream input)
          Deprecated.  
protected static Integer parseLineIndex(String line)
          Deprecated.  
protected abstract  String ruleKey(org.codehaus.staxmate.in.SMInputCursor violationCursor)
          Deprecated.  
 void setDoSaveViolationsOnUnexistedResource(boolean doSaveViolationsOnUnexistedResource)
          Deprecated. Specify if violations must be saved even if when the Resource associated to a violation doesn't yet exist.
protected abstract  Resource toResource(org.codehaus.staxmate.in.SMInputCursor resourceCursor)
          Deprecated. Transforms a given xml resource to a resource Object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rulesManager

protected RulesManager rulesManager
Deprecated. 

context

protected SensorContext context
Deprecated. 

doSaveViolationsOnUnexistedResource

protected boolean doSaveViolationsOnUnexistedResource
Deprecated. 
Constructor Detail

AbstractViolationsStaxParser

@Deprecated
protected AbstractViolationsStaxParser(SensorContext context,
                                                  RulesManager rulesManager,
                                                  RulesProfile profile)
Deprecated. since 1.11.


AbstractViolationsStaxParser

protected AbstractViolationsStaxParser(SensorContext context,
                                       RulesManager rulesManager)
Deprecated. 
Method Detail

cursorForResources

protected abstract org.codehaus.staxmate.in.SMInputCursor cursorForResources(org.codehaus.staxmate.in.SMInputCursor rootCursor)
                                                                      throws javax.xml.stream.XMLStreamException
Deprecated. 
Cursor for child resources to parse, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs

Parameters:
rootCursor - the root xml doc cursor
Returns:
a cursor with child resources elements to parse
Throws:
javax.xml.stream.XMLStreamException

cursorForViolations

protected abstract org.codehaus.staxmate.in.SMInputCursor cursorForViolations(org.codehaus.staxmate.in.SMInputCursor resourcesCursor)
                                                                       throws javax.xml.stream.XMLStreamException
Deprecated. 
Cursor for violations to parse for a given resource, the returned input cursor should be filtered on SMEvent.START_ELEMENT for optimal perfs

Parameters:
resourcesCursor - the current resource cursor
Returns:
a cursor with child violations elements to parse
Throws:
javax.xml.stream.XMLStreamException

toResource

protected abstract Resource toResource(org.codehaus.staxmate.in.SMInputCursor resourceCursor)
                                throws javax.xml.stream.XMLStreamException
Deprecated. 
Transforms a given xml resource to a resource Object

Throws:
javax.xml.stream.XMLStreamException

messageFor

protected abstract String messageFor(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                              throws javax.xml.stream.XMLStreamException
Deprecated. 
Throws:
javax.xml.stream.XMLStreamException

ruleKey

protected abstract String ruleKey(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                           throws javax.xml.stream.XMLStreamException
Deprecated. 
Throws:
javax.xml.stream.XMLStreamException

keyForPlugin

protected abstract String keyForPlugin()
Deprecated. 

lineNumberForViolation

protected abstract String lineNumberForViolation(org.codehaus.staxmate.in.SMInputCursor violationCursor)
                                          throws javax.xml.stream.XMLStreamException
Deprecated. 
Throws:
javax.xml.stream.XMLStreamException

setDoSaveViolationsOnUnexistedResource

public final void setDoSaveViolationsOnUnexistedResource(boolean doSaveViolationsOnUnexistedResource)
Deprecated. 
Specify if violations must be saved even if when the Resource associated to a violation doesn't yet exist. In that case the Resource is automatically created.

Parameters:
doSaveViolationsOnUnexistedResource - by default, the value is true

parse

public void parse(File violationsXMLFile)
           throws javax.xml.stream.XMLStreamException
Deprecated. 
Throws:
javax.xml.stream.XMLStreamException

parse

public final void parse(InputStream input)
                 throws javax.xml.stream.XMLStreamException
Deprecated. 
Throws:
javax.xml.stream.XMLStreamException

parseLineIndex

protected static Integer parseLineIndex(String line)
Deprecated. 


Copyright © 2009-2010 SonarSource. All Rights Reserved.