Report XS

As part of Structure101 it is possible to output all Structure101 Studio XS offenders to an XML file.

Example XML file to perform the operation:

Copy

<?xml version="1.0" encoding="UTF-8"?>
<headless version="1.0">
    <operations>
        <operation type="report-xs">
            <argument name="output-file" value="c:/abc/report-xs.xml"/>
        </operation>
    </operations>
    <arguments>
        <argument name="local-project" value="C:\Documents and Settings\user\project.java.hsp">
            <override attribute="classpath" value="C:\classes-to-parse"/>
        </argument>
    </arguments>
</headless>

Available arguments include:

Argument	Required	Description
repository	yes	The path to the Structure101 Studio repository root directory, e.g. c:/repository, /home/usr/x/repository, or, if remote, http://<servernameorip><:portno>/s101cpp/data
project	yes	The name of the project in the repository
local-project	yes	See project-spec.
output-file	no	File to which metrics are written in XML format.
detailed	no	If detailed is set to “true”, then the list of XS offenders at the method level will be saved to output. If false, the default, only higher level XS offenders are included, e.g. class and package.
use-xs-from-repository	no	The XS configuration stored in the referenced repository will be used instead of the default to determine XS offenders.
use-xs-configuration	no	The name of the XS configuration to use e.g "My Structural XS".