Skip to content

Commit

Permalink
Fix javadoc issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbeckerle committed Nov 11, 2023
1 parent 92e9ecf commit b9f055e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ class Compiler private[japi] (private var sCompiler: SCompiler) {
def compileSource(uri: URI, rootName: String, rootNamespace: String): ProcessorFactory = {
val source = URISchemaSource(uri)
val pf = sCompiler.compileSource(source, Option(rootName), Option(rootNamespace))
new ProcessorFactory(pf.asInstanceOf[SProcessorFactory])
new ProcessorFactory(pf)
}

/**
Expand Down Expand Up @@ -516,13 +516,14 @@ class DataProcessor private[japi] (private var dp: SDataProcessor)
def save(output: WritableByteChannel): Unit = dp.save(output)

/**
* Walks the handler over the runtime [[Metadata]] structures. These provide information
* about name, namespace, type, simple/complex, etc.
* Walks the handler over the runtime [[org.apache.daffodil.runtime1.api.Metadata]] structures.
* These provide information about name, namespace, type, simple/complex, etc.
*
* This is used to interface Daffodil runtime1 metadata to the metadata structures
* of other software systems.
*
* See [[MetadataHandler]] for more motivating materials about runtime1 metadata walking.
* See [[org.apache.daffodil.runtime1.api.MetadataHandler]] for more motivating materials about
* runtime1 metadata walking.
*
* @param handler - the handler is called-back during the walk as each metadata structure is encountered.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@

/**
* Abstract class used by ServiceLoader to poll for UDF providers on classpath.
*
* <p>
* Through this class, several User Defined Functions can be made available to
* Daffodil via a single entry in the META-INF/services file.
*
* <p>
* UDF Providers must subclass this, and must initialize the
* userDefinedFunctionClasses array with all the UDF classes it is providing.
*
* <p>
* If the UDFs being provided have constructors with arguments, the provider
* subclass must also implement the createUserDefinedFunction to return an
* initialized function class object based on the supplied namespace and name.
*
* <p>
* Subclasses must also supply a
* src/META-INF/services/org.apache.daffodil.udf.UserDefinedFunctionProvider
* file in their JAVA project in order to be discoverable by Daffodil.
Expand Down Expand Up @@ -61,13 +61,13 @@ public abstract class UserDefinedFunctionProvider {
* @return initialized UserDefinedFunction object that must contain evaluate
* function with desired functionality
*
* @throws SecurityException
* @throws java.lang.SecurityException
* if security manager exists and disallows access
* @throws IllegalArgumentException
* @throws java.lang.IllegalArgumentException
* if the UDF doesn't have a no-argument constructor
* @throws ExceptionInInitializerError
* @throws java.lang.ExceptionInInitializerError
* if there is an issue initializing the UDF object
* @throws ReflectiveOperationException
* @throws java.lang.ReflectiveOperationException
* if the UDF doesn't have a no-argument constructor or if there is an
* issue initializing the UDF object
*/
Expand Down

0 comments on commit b9f055e

Please sign in to comment.