org.mule.sdk.api.annotation.semantics.file

Annotation Type FilePath

@Target(value={PARAMETER,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface FilePath

Marks a field or parameter annotated with Parameter as a path to a file or directory.

This annotation should only be used with String parameters.

Since:

1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	acceptedFileExtensions
boolean	acceptsUrls
org.mule.runtime.api.meta.model.display.PathModel.Location	location
org.mule.runtime.api.meta.model.display.PathModel.Type	type

Element Detail

type

public abstract org.mule.runtime.api.meta.model.display.PathModel.Type type

Returns:

whether the path is to a directory or a file

Default:

org.mule.runtime.api.meta.model.display.PathModel.Type.ANY

acceptsUrls

public abstract boolean acceptsUrls

Returns:

whether the path parameter also supports urls.

Default:

false

location

public abstract org.mule.runtime.api.meta.model.display.PathModel.Location location

Returns:

a classifier for the path's generic PathModel.Location

Default:

org.mule.runtime.api.meta.model.display.PathModel.Location.ANY

acceptedFileExtensions

public abstract String[] acceptedFileExtensions

Returns:

the file extensions that this path handles.

Default:

{}