GlobalyzerAPIScanDetails

java.lang.Object
- com.lingoport.api.GlobalyzerAPIScanDetails

```
public class GlobalyzerAPIScanDetails
extends java.lang.Object
```
This class provides scan details and is used by the API's createScan() and createProjectScans() methods.

Constructor Summary

Constructors
Constructor and Description

GlobalyzerAPIScanDetails()
Creates a new ScanDetail object with default settings.

Constructors
Constructor and Description
`GlobalyzerAPIScanDetails()` Creates a new ScanDetail object with default settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getCheckEmbeddedStrings()` Return whether or not scan checks for embedded strings.
`java.lang.Boolean`	`getCheckGeneralPatterns()` Return whether or not scan checks for general patterns.
`java.lang.Boolean`	`getCheckLocaleSensitiveMethods()` Return whether or not scan checks for locale-sensitive methods.
`java.lang.Boolean`	`getCheckStaticFileReferences()` Return whether or not scan checks for static file references.
`java.lang.String`	`getEncoding()` Return the source file encoding for the scan.
`java.lang.String`	`getEndIgnoreComment()` Return scan's end ignore comment.
`java.lang.String`	`getIgnoreNextLineComment()` Return scan's ignore next line comment.
`java.lang.String[]`	`getScanItems()` Return the items to scan.
`java.lang.String`	`getStartIgnoreComment()` Return scan's start ignore comment.
`java.lang.String`	`getTodoComment()` Return scan's todo comment.
`java.lang.Boolean`	`getUseMachineLearning()` Return whether or not to use machine learning when scanning.
`void`	`setCheckEmbeddedStrings(java.lang.Boolean check)` Set whether or not scan should check for embedded strings.
`void`	`setCheckGeneralPatterns(java.lang.Boolean check)` Set whether or not scan should check for general patterns.
`void`	`setCheckLocaleSensitiveMethods(java.lang.Boolean check)` Set whether or not scan should check for locale-sensitive methods.
`void`	`setCheckStaticFileReferences(java.lang.Boolean check)` Set whether or not scan should check for static file references.
`void`	`setEncoding(java.lang.String encoding)` Set the encoding for the scan.
`void`	`setEndIgnoreComment(java.lang.String comment)` Set scan's end ignore comment text.
`void`	`setIgnoreNextLineComment(java.lang.String comment)` Set scan's ignore next line comment text.
`void`	`setScanItems(java.lang.String[] scanItems)` Set the items to scan.
`void`	`setStartIgnoreComment(java.lang.String comment)` Set scan's start ignore comment text.
`void`	`setTodoComment(java.lang.String comment)` Set scan's todo comment text.
`void`	`setUseMachineLearning(java.lang.Boolean useMachineLearning)` Set whether or not to use machine learning when scanning.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GlobalyzerAPIScanDetails
```
public GlobalyzerAPIScanDetails()
```
    Creates a new ScanDetail object with default settings.
- Method Detail
  - setScanItems
```
public void setScanItems(java.lang.String[] scanItems)
```
    Set the items to scan.
    
    Parameters:
    
    scanItems - List of files/directories to scan. Maybe be relative (to project path) or absolute
  - setUseMachineLearning
```
public void setUseMachineLearning(java.lang.Boolean useMachineLearning)
```
    Set whether or not to use machine learning when scanning. Default is false.
    
    Parameters:
    
    useMachineLearning - true, false, or null (to use default setting)
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
                 throws GlobalyzerAPIException
```
    Set the encoding for the scan. The default encoding is "systemDefault". Valid encodings include "UTF-8", "UTF-16", etc. Anything returned from Java's Charset.availableCharsets().keySet() is valid.
    
    Parameters:
    
    encoding - The source file encoding for the scan
    
    Throws:
    
    GlobalyzerAPIException - if encoding is invalid
  - setCheckEmbeddedStrings
```
public void setCheckEmbeddedStrings(java.lang.Boolean check)
```
    Set whether or not scan should check for embedded strings. Default is true.
    
    Parameters:
    
    check - true, false, or null (to use default setting)
  - setCheckLocaleSensitiveMethods
```
public void setCheckLocaleSensitiveMethods(java.lang.Boolean check)
```
    Set whether or not scan should check for locale-sensitive methods. Default is true.
    
    Parameters:
    
    check - true, false, or null (to use default setting)
  - setCheckGeneralPatterns
```
public void setCheckGeneralPatterns(java.lang.Boolean check)
```
    Set whether or not scan should check for general patterns. Default is true.
    
    Parameters:
    
    check - true, false, or null (to use default setting)
  - setCheckStaticFileReferences
```
public void setCheckStaticFileReferences(java.lang.Boolean check)
```
    Set whether or not scan should check for static file references. Default is true.
    
    Parameters:
    
    check - true, false, or null (to use default setting)
  - setTodoComment
```
public void setTodoComment(java.lang.String comment)
```
    Set scan's todo comment text.
    
    Parameters:
    
    comment - Todo comment text for the scan; null = use default setting
  - setIgnoreNextLineComment
```
public void setIgnoreNextLineComment(java.lang.String comment)
```
    Set scan's ignore next line comment text.
    
    Parameters:
    
    comment - Ignore next line comment text for the scan; null = use default setting
  - setStartIgnoreComment
```
public void setStartIgnoreComment(java.lang.String comment)
```
    Set scan's start ignore comment text.
    
    Parameters:
    
    comment - Start ignore comment text for the scan; null = use default setting
  - setEndIgnoreComment
```
public void setEndIgnoreComment(java.lang.String comment)
```
    Set scan's end ignore comment text.
    
    Parameters:
    
    comment - End ignore comment text for the scan; null = use default setting
  - getScanItems
```
public java.lang.String[] getScanItems()
```
    Return the items to scan.
    
    Returns:
    
    the items to scan; null = all
  - getUseMachineLearning
```
public java.lang.Boolean getUseMachineLearning()
```
    Return whether or not to use machine learning when scanning.
    
    Returns:
    
    whether or not to use machine learning when scanning; null = default setting
  - getEncoding
```
public java.lang.String getEncoding()
```
    Return the source file encoding for the scan.
    
    Returns:
    
    the source file encoding for the scan; null = default encoding
  - getCheckEmbeddedStrings
```
public java.lang.Boolean getCheckEmbeddedStrings()
```
    Return whether or not scan checks for embedded strings.
    
    Returns:
    
    whether or not scan checks for embedded strings; null = default setting
  - getCheckLocaleSensitiveMethods
```
public java.lang.Boolean getCheckLocaleSensitiveMethods()
```
    Return whether or not scan checks for locale-sensitive methods.
    
    Returns:
    
    whether or not scan checks for locale-sensitive methods; null = default setting
  - getCheckGeneralPatterns
```
public java.lang.Boolean getCheckGeneralPatterns()
```
    Return whether or not scan checks for general patterns.
    
    Returns:
    
    whether or not scan checks for general patterns; null = default setting
  - getCheckStaticFileReferences
```
public java.lang.Boolean getCheckStaticFileReferences()
```
    Return whether or not scan checks for static file references.
    
    Returns:
    
    whether or not scan checks for static file references; null = default setting
  - getTodoComment
```
public java.lang.String getTodoComment()
```
    Return scan's todo comment.
    
    Returns:
    
    scan's todo comment; null = default setting
  - getIgnoreNextLineComment
```
public java.lang.String getIgnoreNextLineComment()
```
    Return scan's ignore next line comment.
    
    Returns:
    
    scan's ignore next line comment; null = default setting
  - getStartIgnoreComment
```
public java.lang.String getStartIgnoreComment()
```
    Return scan's start ignore comment.
    
    Returns:
    
    scan's start ignore comment; null = default setting
  - getEndIgnoreComment
```
public java.lang.String getEndIgnoreComment()
```
    Return scan's end ignore comment.
    
    Returns:
    
    scan's end ignore comment; null = default setting

Class GlobalyzerAPIScanDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalyzerAPIScanDetails

Method Detail

setScanItems

setUseMachineLearning

setEncoding

setCheckEmbeddedStrings

setCheckLocaleSensitiveMethods

setCheckGeneralPatterns

setCheckStaticFileReferences

setTodoComment

setIgnoreNextLineComment

setStartIgnoreComment

setEndIgnoreComment

getScanItems

getUseMachineLearning

getEncoding

getCheckEmbeddedStrings

getCheckLocaleSensitiveMethods

getCheckGeneralPatterns

getCheckStaticFileReferences

getTodoComment

getIgnoreNextLineComment

getStartIgnoreComment

getEndIgnoreComment