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

Annotation Interface FilePath

@Target({PARAMETER,FIELD}) @Retention(RUNTIME) @Documented @MinMuleVersion("4.4") @DoNotEnforceMinMuleVersion 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
    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 Details

    • type

      org.mule.runtime.api.meta.model.display.PathModel.Type type
      Returns:
      whether the path is to a directory or a file
      Default:
      ANY

    • acceptsUrls

      boolean acceptsUrls
      Returns:
      whether the path parameter also supports urls.
      Default:
      false

    • location

      org.mule.runtime.api.meta.model.display.PathModel.Location location
      Returns:
      a classifier for the path's generic PathModel.Location
      Default:
      ANY

    • acceptedFileExtensions

      String[] acceptedFileExtensions
      Returns:
      the file extensions that this path handles.
      Default:
      {}