BooleanBinaryAGQualifiedMixin

Type Members

type PropItem = (String, (String, LookupLocation))

type of a map entry which maps a property name as key, to a property value, and along side it is a LookupLocation object telling us where we found that property value.
type of a map entry which maps a property name as key, to a property value, and along side it is a LookupLocation object telling us where we found that property value.
The property maps/lists in DFDLFormatAnnotation have been enhanced to have this LookupLocation thing along their side to allow issuing better diagnostic messages about conflicting property definitions

Definition Classes
PropTypes
type PropMap = Map[String, (String, LookupLocation)]

Definition Classes
PropTypes

Abstract Value Members

abstract def SDE(id: String, args: Any*): Nothing

Definition Classes
SavesErrorsAndWarnings
abstract def SDEButContinue(str: String, args: Any*): Unit

Definition Classes
SavesErrorsAndWarnings
abstract def SDW(warnID: WarnID, str: String, args: Any*): Unit

Issue a warning.
Issue a warning. The WarnID enables suppression of warning messages.

Definition Classes
SavesErrorsAndWarnings
abstract def lookupProperty(pname: String): PropertyLookupResult

Implemented in various ways by users of the mixin to find a property.
Implemented in various ways by users of the mixin to find a property. This should never be directly called to find a property. Instead one should use findPropertyOption and friends, which ensure that caching is consistent.

Attributes
protected
Definition Classes
FindPropertyMixin
abstract def schemaFileLocation: SchemaFileLocation

Definition Classes
ThrowsSDE

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def SDE(th: Throwable): Nothing

Definition Classes
ThrowsSDE
def ThrowSDE: PartialFunction[Throwable, Nothing]

Definition Classes
ThrowsSDE
final def areLogging(lvl: Type): Boolean

Definition Classes
Logging
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def binaryBooleanFalseRep: ULong
final def binaryBooleanFalseRep_location: LookupLocation
final def binaryBooleanTrueRep: MaybeULong
final def binaryBooleanTrueRep_location: LookupLocation
def booleanBinaryAGQualifiedInit(): Unit
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def convertToBoolean(pv: String): Boolean

Convert a property string value to a Boolean
Convert a property string value to a Boolean
Note: no error checking is required, as we assume the schema has already been validated, so we only have to deal with the valid formats for Boolean.

Definition Classes
PropertyMixin
def convertToDouble(pv: String): Double

Definition Classes
PropertyMixin
def convertToFloat(pv: String): Float

Definition Classes
PropertyMixin
def convertToInt(pv: String): Int

Convert a property string value to a Int
Convert a property string value to a Int
Note: no error checking is required, as we assume the schema has already been validated, so we only have to deal with the valid formats for Int.

Definition Classes
PropertyMixin
def convertToNCName(pv: String): String

Definition Classes
PropertyMixin
def convertToQName(pv: String, pl: LookupLocation): RefQName

Definition Classes
PropertyMixin
def convertToString(pv: String): String

There's no conversion to do here, but to eliminate a special case in the code generator we always generate a call to a convertToTYPE function.
There's no conversion to do here, but to eliminate a special case in the code generator we always generate a call to a convertToTYPE function.

Definition Classes
PropertyMixin
def doLogging(lvl: Type, msg: String, args: Seq[Any]): Unit

Attributes
protected
Definition Classes
Logging
val emptyPropMap: PropMap

Definition Classes
PropTypes
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def findProperty(pname: String): Found

Call this to find/get a property.
Call this to find/get a property.
Property values are non-optional in DFDL. If they're not there but a format requires them, then it's always an error.
Note also that DFDL doesn't have default values for properties. That means that most use of properties is unconditional. Get the property value, and it must be there, or its an error. There are very few exceptions to this rule.

Definition Classes
FindPropertyMixin
def findPropertyOption(pname: String): PropertyLookupResult

Definition Classes
FindPropertyMixin
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getLogWriter(): LogWriter

Definition Classes
Logging
final def getLoggingLevel(): Type

Definition Classes
Logging
final def getProperty(pname: String): String

It is ok to use getProperty if the resulting property value cannot ever contain a QName that would have to be resolved.
It is ok to use getProperty if the resulting property value cannot ever contain a QName that would have to be resolved.

Definition Classes
FindPropertyMixin
final def getPropertyOption(pname: String): Option[String]

Don't use this much.
Don't use this much. If an SDE needs to be reported, you won't have the source of the property to put into the message. Use findPropertyOption instead. That returns the value and the LookupLocation where it was found for use in diagnostics.
Also, don't use if the property value could ever contain a QName, because one needs that LookupLocation to resolve QNames properly.
Note: any expression can contain QNames, so no expression-valued property or one that could be a value or an expression, should ever use this or getProperty.
See JIRA DFDL-506.

Definition Classes
FindPropertyMixin
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final macro def log(lvl: Type, msg: String, args: Any*): Unit

Definition Classes
Logging
lazy val logID: String

Definition Classes
Logging → Identity
var logLevel: Maybe[Type]

Definition Classes
Logging
var logWriter: Maybe[LogWriter]

Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notYetImplemented(msg: String, args: Any*): Nothing

Definition Classes
ThrowsSDE
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val propCache: LinkedHashMap[String, PropertyLookupResult]

Definition Classes
FindPropertyMixin
def registerToStringFunction(f: () ⇒ String): Unit

Definition Classes
PropertyMixin
final def requireProperty(prop: PropertyLookupResult): Found

Definition Classes
FindPropertyMixin
final def schemaDefinitionError(str: String, args: Any*): Nothing

Definition Classes
ThrowsSDE
def schemaDefinitionErrorButContinue(str: String, args: Any*): Unit

Definition Classes
SavesErrorsAndWarnings
def schemaDefinitionErrorDueToPropertyValue(propertyName: String, propertyValue: String, propertyLocation: LookupLocation, otherPropertyLocation: LookupLocation, str: String, args: Any*): Nothing

SDE special case when we're blaming the error on the value of a property.
SDE special case when we're blaming the error on the value of a property. If the location where the property value is defined is different from the current context, then we inform about both the context location, and the location where the property value comes from.

Definition Classes
SavesErrorsAndWarnings
final macro def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: String, args: Any*): Unit

* These functions are now macros as the original code: final def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: => String, args: => Any*) = if (!testThatWillThrowIfFalse) SDE(str, args: _*) would cause expensive object allocation, even when the test would be true and even when the function was inlined
* These functions are now macros as the original code: final def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: => String, args: => Any*) = if (!testThatWillThrowIfFalse) SDE(str, args: _*) would cause expensive object allocation, even when the test would be true and even when the function was inlined

Definition Classes
ThrowsSDE
macro def schemaDefinitionWarningUnless(warnID: WarnID, testThatWillWarnIfFalse: Boolean, str: String, args: Any*): Unit

Conditionally issue a warning.
Conditionally issue a warning. The WarnID allows warning suppression.

Definition Classes
SavesErrorsAndWarnings
macro def schemaDefinitionWarningWhen(warnID: WarnID, testThatWillWarnIfTrue: Boolean, str: String, args: Any*): Unit

Conditionally issue a warning.
Conditionally issue a warning. The WarnID allows warning suppression.

Definition Classes
SavesErrorsAndWarnings
final macro def schemaDefinitionWhen(testThatWillThrowIfTrue: Boolean, str: String, args: Any*): Unit

Definition Classes
ThrowsSDE
def setLogWriter(lw: LogWriter): Unit

Definition Classes
Logging
def setLoggingLevel(level: Type): Unit

Definition Classes
Logging
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
var toStringFunctionList: List[() ⇒ String]

Properties will push their toString function onto this list
Properties will push their toString function onto this list
Each object that has any properties mixed in must implement this value.

Definition Classes
PropertyMixin
final def toss(th: Throwable): Nothing

Centralize throwing for debug convenience
Centralize throwing for debug convenience

Definition Classes
ThrowsSDE
def verboseToString: String

prints all the properties on the object.
prints all the properties on the object.

Definition Classes
PropertyMixin
def verifyPropValue(key: String, value: String): Boolean

For unit testing convenience, or for use when debugging.
For unit testing convenience, or for use when debugging.

Definition Classes
FindPropertyMixin
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
macro def withLoggingLevel[S](newLevel: Type = getLoggingLevel)(body: ⇒ S): Unit

Use to make debug printing over small code regions convenient.
Use to make debug printing over small code regions convenient. Turns on your logging level of choice over a lexical region of code. Makes sure it is reset to whatever it was on the exit, even if it throws.
Call with no log level argument to turn it off (when done debugging). That way you can leave it sitting there.

Definition Classes
Logging

Related Doc: package gen

trait BooleanBinaryAGQualifiedMixin extends PropertyMixin

Type Members

type PropItem = (String, (String, LookupLocation))

type PropMap = Map[String, (String, LookupLocation)]

Abstract Value Members

abstract def SDE(id: String, args: Any*): Nothing

abstract def SDEButContinue(str: String, args: Any*): Unit

abstract def SDW(warnID: WarnID, str: String, args: Any*): Unit

abstract def lookupProperty(pname: String): PropertyLookupResult

abstract def schemaFileLocation: SchemaFileLocation

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def SDE(th: Throwable): Nothing

def ThrowSDE: PartialFunction[Throwable, Nothing]

final def areLogging(lvl: Type): Boolean

final def asInstanceOf[T0]: T0

final def binaryBooleanFalseRep: ULong

final def binaryBooleanFalseRep_location: LookupLocation

final def binaryBooleanTrueRep: MaybeULong

final def binaryBooleanTrueRep_location: LookupLocation

def booleanBinaryAGQualifiedInit(): Unit

def clone(): AnyRef

def convertToBoolean(pv: String): Boolean

def convertToDouble(pv: String): Double

def convertToFloat(pv: String): Float

def convertToInt(pv: String): Int

def convertToNCName(pv: String): String

def convertToQName(pv: String, pl: LookupLocation): RefQName

def convertToString(pv: String): String

def doLogging(lvl: Type, msg: String, args: Seq[Any]): Unit

val emptyPropMap: PropMap

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def findProperty(pname: String): Found

def findPropertyOption(pname: String): PropertyLookupResult

final def getClass(): Class[_]

def getLogWriter(): LogWriter

final def getLoggingLevel(): Type

final def getProperty(pname: String): String

final def getPropertyOption(pname: String): Option[String]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final macro def log(lvl: Type, msg: String, args: Any*): Unit

lazy val logID: String

var logLevel: Maybe[Type]

var logWriter: Maybe[LogWriter]

final def ne(arg0: AnyRef): Boolean

final def notYetImplemented(msg: String, args: Any*): Nothing

final def notify(): Unit

final def notifyAll(): Unit

val propCache: LinkedHashMap[String, PropertyLookupResult]

def registerToStringFunction(f: () ⇒ String): Unit

final def requireProperty(prop: PropertyLookupResult): Found

final def schemaDefinitionError(str: String, args: Any*): Nothing

def schemaDefinitionErrorButContinue(str: String, args: Any*): Unit

def schemaDefinitionErrorDueToPropertyValue(propertyName: String, propertyValue: String, propertyLocation: LookupLocation, otherPropertyLocation: LookupLocation, str: String, args: Any*): Nothing

final macro def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: String, args: Any*): Unit

macro def schemaDefinitionWarningUnless(warnID: WarnID, testThatWillWarnIfFalse: Boolean, str: String, args: Any*): Unit

macro def schemaDefinitionWarningWhen(warnID: WarnID, testThatWillWarnIfTrue: Boolean, str: String, args: Any*): Unit

final macro def schemaDefinitionWhen(testThatWillThrowIfTrue: Boolean, str: String, args: Any*): Unit

def setLogWriter(lw: LogWriter): Unit

def setLoggingLevel(level: Type): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

var toStringFunctionList: List[() ⇒ String]

final def toss(th: Throwable): Nothing

def verboseToString: String

def verifyPropValue(key: String, value: String): Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

macro def withLoggingLevel[S](newLevel: Type = getLoggingLevel)(body: ⇒ S): Unit

Inherited from PropertyMixin

Inherited from Logging

Inherited from Identity