agi.foundation.stk

(agi.foundation.models-2024r2.jar)

Class StkPatternFileOptions

java.lang.Object

agi.foundation.stk.StkPatternFileOptions

public class StkPatternFileOptions
extends Object

Specifies options for reading and creating a StkPatternFile.

Constructor Summary

Constructors

Constructor and Description
StkPatternFileOptions()

Method Summary

Modifier and Type	Method and Description
boolean	getIgnorePropertiesWithUnsupportedValues() Gets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file if the property has a value that the reader does not understand.
boolean	getIgnoreUnsupportedProperties() Gets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file that it does not understand.
void	setIgnorePropertiesWithUnsupportedValues(boolean value) Sets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file if the property has a value that the reader does not understand.
void	setIgnoreUnsupportedProperties(boolean value) Sets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file that it does not understand.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StkPatternFileOptions

public StkPatternFileOptions()

Method Detail

getIgnoreUnsupportedProperties

public final boolean getIgnoreUnsupportedProperties()

Gets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file that it does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the unsupported property in the UnsupportedProperties (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the pattern file. Setting this property to true will also cause the reader to ignore pattern blocks in an unsupported format.

setIgnoreUnsupportedProperties

public final void setIgnoreUnsupportedProperties(boolean value)

Sets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file that it does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the unsupported property in the UnsupportedProperties (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the pattern file. Setting this property to true will also cause the reader to ignore pattern blocks in an unsupported format.

getIgnorePropertiesWithUnsupportedValues

public final boolean getIgnorePropertiesWithUnsupportedValues()

Gets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file if the property has a value that the reader does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the property with the unsupported value in the PropertiesWithUnsupportedValues (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the pattern file.

setIgnorePropertiesWithUnsupportedValues

public final void setIgnorePropertiesWithUnsupportedValues(boolean value)

Sets a value indicating whether StkPatternFile.readFrom(BufferedReader,StkPatternFileOptions) will ignore a property in the pattern file if the property has a value that the reader does not understand. If this property is false, the reader will throw an InvalidDataException when it encounters such a property. If this property is true, the reader will note the property with the unsupported value in the PropertiesWithUnsupportedValues (get) collection but will otherwise ignore it, which can result in incorrect interpretation of the data in the pattern file.