com.github.ramonwirsch.fopRenderer

Class SchemaConfigExtension

java.lang.Object

com.github.ramonwirsch.fopRenderer.SchemaConfigExtension

public class SchemaConfigExtension
extends java.lang.Object

Created by Ramon on 03.08.2016.

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL	FALLBACK_URL Placeholder to configure plugin for implicit schemas (the ones that are configured within the xml files themselves)

Constructor Summary

Constructors

Constructor and Description
SchemaConfigExtension(java.lang.String name, org.gradle.api.Project project)

Method Summary

Modifier and Type	Method and Description
org.gradle.api.file.FileCollection	getFiles() Files to validate
java.lang.String	getName()
java.io.File	getOfflineSchema() Local backup location for schemas
org.gradle.api.Project	getProject()
java.io.File	getSchemaDir() Directory containing all the schemas
java.net.URL	getSchemaUri() Get the configured schema Defaults to implicit schemas
boolean	isUseInherentSchemas() force use of XML schemas configured inside source files
void	setFiles(java.io.File file) Files to validate
void	setFiles(org.gradle.api.file.FileCollection files) Files to validate
void	setOfflineSchema(java.io.File offlineSchema) Local backup location for schemas
void	setSchemaDir(java.io.File dir) Directory containing all the schemas
void	setSchemaUri(java.io.File file) Set the schema to use for validation Defaults to implicit schemas
void	setSchemaUri(java.lang.String uri) Set the schema to use for validation Defaults to implicit schemas
void	setSchemaUri(java.net.URL uri) Set the schema to use for validation Defaults to implicit schemas
void	setUseInherentSchemas(boolean useInherentSchemas) force use of XML schemas configured inside source files

Methods inherited from class java.lang.Object

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

Field Detail

FALLBACK_URL

public static final java.net.URL FALLBACK_URL

Placeholder to configure plugin for implicit schemas (the ones that are configured within the xml files themselves)

Constructor Detail

SchemaConfigExtension

public SchemaConfigExtension(java.lang.String name,
                             org.gradle.api.Project project)

Method Detail

getProject

public org.gradle.api.Project getProject()

getName

public java.lang.String getName()

getSchemaDir

public java.io.File getSchemaDir()

Directory containing all the schemas

Returns:

schema directory

setSchemaDir

public void setSchemaDir(java.io.File dir)

Directory containing all the schemas

Parameters:

dir - schema directory

getOfflineSchema

public java.io.File getOfflineSchema()

Local backup location for schemas

Returns:

parent dir of offline schemas

setOfflineSchema

public void setOfflineSchema(java.io.File offlineSchema)

Local backup location for schemas

Parameters:

offlineSchema - parent dir of offline schemas

isUseInherentSchemas

public boolean isUseInherentSchemas()

force use of XML schemas configured inside source files

Returns:

if enabled

setUseInherentSchemas

public void setUseInherentSchemas(boolean useInherentSchemas)

force use of XML schemas configured inside source files

Parameters:

useInherentSchemas - boolean

setFiles

public void setFiles(java.io.File file)

Files to validate

Parameters:

file - single file to validate

getFiles

public org.gradle.api.file.FileCollection getFiles()

Files to validate

Returns:

files to validate

setFiles

public void setFiles(org.gradle.api.file.FileCollection files)

Files to validate

Parameters:

files - files to validate

getSchemaUri

public java.net.URL getSchemaUri()

Get the configured schema Defaults to implicit schemas

Returns:

schema file, can be URL

setSchemaUri

public void setSchemaUri(java.io.File file)
                  throws java.net.MalformedURLException

Set the schema to use for validation Defaults to implicit schemas

Parameters:

file - local schema file

Throws:

java.net.MalformedURLException - in case of invalid URL

setSchemaUri

public void setSchemaUri(java.net.URL uri)

Set the schema to use for validation Defaults to implicit schemas

Parameters:

uri - schema URL

setSchemaUri

public void setSchemaUri(java.lang.String uri)
                  throws java.net.MalformedURLException

Set the schema to use for validation Defaults to implicit schemas

Parameters:

uri - schema URL

Throws:

java.net.MalformedURLException - in case of invalid URL