PathFactory (Gradle API 2.14.1)

org.gradle.plugins.ide.idea.model

## Class PathFactory

- java.lang.Object
- - groovy.lang.GroovyObjectSupport
  - - org.gradle.plugins.ide.idea.model.PathFactory

- All Implemented Interfaces:
    GroovyObject

      public class PathFactory
      extends GroovyObjectSupport

  Path Factory.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `PathFactory()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `PathFactory` | `addPathVariable(String name, File dir)`
    `FilePath` | `path(File file)` Creates a path for the given file.
    `FilePath` | `path(File file, boolean useFileScheme)` Creates a path for the given file.
    `Path` | `path(String url)` Creates a path for the given URL.
    `Path` | `path(String url, String relPath)` Creates a path for the given URL.
    `FilePath` | `relativePath(String pathVar, File file)` Creates a path relative to the given path variable.

    - ### Methods inherited from class groovy.lang.GroovyObjectSupport

      `getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PathFactory

          public PathFactory()

  - ### Method Detail

    - #### addPathVariable

          public PathFactory addPathVariable(String name,
                                    File dir)

    - #### path

          public FilePath path(File file)

      Creates a path for the given file.

    - #### path

          public FilePath path(File file,
                      boolean useFileScheme)

      Creates a path for the given file.
      Parameters:
        `file` - The file to generate a path for
        `useFileScheme` - Whether 'file://' prefixed URI should be used even for JAR files

    - #### relativePath

          public FilePath relativePath(String pathVar,
                              File file)

      Creates a path relative to the given path variable.

    - #### path

          public Path path(String url)

      Creates a path for the given URL.

    - #### path

          public Path path(String url,
                  String relPath)

      Creates a path for the given URL.