com.atlassian.jira.functest.config
Class CheckOptionsUtils

java.lang.Object
  extended by com.atlassian.jira.functest.config.CheckOptionsUtils

public final class CheckOptionsUtils
extends Object

Class to read and update CheckOptions instances.

Since:
v4.0

Method Summary
static CheckOptions allOptions()
           
protected  Object clone()
           
static CheckOptions disabled(String... options)
           
static CheckOptions noOptions()
           
static CheckOptions parseOptions(org.dom4j.Document document)
          Creates a CheckOptions object by parsing through the comments at the top level of the passed document and looking for lines of the form:

suppresscheck: check

or

suppresschecks: check, check2

There a special check called "all".

static void writeOptions(org.dom4j.Document document, CheckOptions options)
          Writes the passed CheckOptions object to a comment in the passed document.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

clone

protected Object clone()
                throws CloneNotSupportedException
Overrides:
clone in class Object
Throws:
CloneNotSupportedException

allOptions

public static CheckOptions allOptions()

noOptions

public static CheckOptions noOptions()

disabled

public static CheckOptions disabled(String... options)

parseOptions

public static CheckOptions parseOptions(org.dom4j.Document document)
Creates a CheckOptions object by parsing through the comments at the top level of the passed document and looking for lines of the form:

suppresscheck: check

or

suppresschecks: check, check2

There a special check called "all". When specified all the checks will be suppressed.

Parameters:
document - the document to scan.
Returns:
a CheckOptions object configured from the passed document.

writeOptions

public static void writeOptions(org.dom4j.Document document,
                                CheckOptions options)
Writes the passed CheckOptions object to a comment in the passed document.

Parameters:
document - the document to write to.
options - the options to write to the passed document.


Copyright © 2002-2012 Atlassian. All Rights Reserved.