GroovyCodeSource (Groovy 5.0.0)
Description: declaration: package: groovy.lang, class: GroovyCodeSource

Package groovy.lang

# Class GroovyCodeSource

java.lang.Object
groovy.lang.GroovyCodeSource

public class GroovyCodeSource extends Object
CodeSource wrapper class that allows specific security policies to be associated with a class compiled from groovy source.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `GroovyCodeSource(File infile)`
  `GroovyCodeSource(File infile, String encoding)`
  `GroovyCodeSource(Reader reader, String name, String codeBase)`
  Construct a GroovyCodeSource for an inputStream of groovyCode that has an unknown provenance -- meaning it didn't come from a File or a URL (e.g. a String).
  `GroovyCodeSource(String script, String name, String codeBase)`
  `GroovyCodeSource(URI uri)`
  `GroovyCodeSource(URL url)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `equals(Object o)`
  `CodeSource`
  `getCodeSource()`
  `File`
  `getFile()`
  `String`
  `getName()`
  `String`
  `getScriptText()`
  `URL`
  `getURL()`
  `int`
  `hashCode()`
  `boolean`
  `isCachable()`
  `void`
  `setCachable(boolean b)`

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

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

- ## Constructor Details

  - ### GroovyCodeSource

    public GroovyCodeSource(String script, String name, String codeBase)

  - ### GroovyCodeSource

    public GroovyCodeSource(Reader reader, String name, String codeBase)
    Construct a GroovyCodeSource for an inputStream of groovyCode that has an unknown provenance -- meaning it didn't come from a File or a URL (e.g. a String). The supplied codeBase will be used to construct a File URL that should match up with a java Policy entry that determines the grants to be associated with the class that will be built from the InputStream.

    The permission groovy.security.GroovyCodeSourcePermission will be used to determine if the given codeBase may be specified. That is, the current Policy set must have a GroovyCodeSourcePermission that implies the codeBase, or an exception will be thrown. This is to prevent callers from hijacking existing codeBase policy entries unless explicitly authorized by the user.

  - ### GroovyCodeSource

    public GroovyCodeSource(File infile, String encoding) throws IOException
    Throws:
      `IOException`

  - ### GroovyCodeSource

    public GroovyCodeSource(File infile) throws IOException
    Parameters:
      `infile` - the file to create a GroovyCodeSource for.
    Throws:
      `IOException` - if an issue arises opening and reading the file.

  - ### GroovyCodeSource

    public GroovyCodeSource(URI uri) throws IOException
    Throws:
      `IOException`

  - ### GroovyCodeSource

    public GroovyCodeSource(URL url)

- ## Method Details

  - ### getCodeSource

    public CodeSource getCodeSource()

  - ### getScriptText

    public String getScriptText()

  - ### getName

    public String getName()

  - ### getFile

    public File getFile()

  - ### getURL

    public URL getURL()

  - ### setCachable

    public void setCachable(boolean b)

  - ### isCachable

    public boolean isCachable()

  - ### equals

    public boolean equals(Object o)
    Overrides:
      `equals` in class `Object`

  - ### hashCode

    public int hashCode()
    Overrides:
      `hashCode` in class `Object`