serverpackcreator-api/de.griefed.serverpackcreator.api.config/InclusionSpecification

InclusionSpecification

class InclusionSpecification(var source: String, var destination: String? = null, var inclusionFilter: String? = null, var exclusionFilter: String? = null)

A FileInclusionSpecification is at minimum a source-declaration from which files and directories will be included in the server pack to be generated.

Optionally, the following values can be specified:

  • Destination

  • Inclusion-filter (regex)

  • Exclusion-filter (regex)

  • When a destination is specified, then every file and directory acquired from the source will be copied to the specified destination in the server pack, whereas otherwise the source would be copied to a destination in the server pack matching the name of the source.

  • Inclusion filters help to further limit the files and directories to be included from the specified source. Any file and directory matching this filter will be included.

  • Exclusion filters help to further limit the files and directories to be included from the specified source. Any file and directory matching this filter will NOT be included.

Author

Griefed

Constructors

Link copied to clipboard
constructor(source: String, destination: String? = null, inclusionFilter: String? = null, exclusionFilter: String? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var source: String

Functions

Link copied to clipboard
fun asHashMap(): HashMap<String, String>

Get this inclusion-spec as a hashmap.

Link copied to clipboard
fun hasDestination(): Boolean

Whether this inclusion-spec has a destination in the server-pack-to-be set.

Link copied to clipboard
fun hasExclusionFilter(): Boolean

Whether this inclusion-spec has an Exclusion-Filter present.

Link copied to clipboard
fun hasInclusionFilter(): Boolean

Whether this inclusion-spec has an Inclusion-Filter present.

Link copied to clipboard
fun isGlobalFilter(): Boolean

Whether this inclusion-spec is a global filter to be applied to every inclusion. A global filter requires the source to be empty and/or blank and an inclusion- or exclusion-filter to be set.