Script (groovy 2.4.4 API)

groovy.lang.Script

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors
Constructor and description
`protected Script ()`
`protected Script (Binding binding)`

Methods Summary

Methods
Type	Name and description
`Object`	`evaluate(String expression)` A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scope
`Object`	`evaluate(File file)` A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scope
`Binding`	`getBinding()`
`Object`	`getProperty(String property)`
`Object`	`invokeMethod(String name, Object args)` Invoke a method (or closure in the binding) defined.
`void`	`print(Object value)` Prints the value to the current 'out' variable which should be a PrintWriter or at least have a print() method defined on it.
`void`	`printf(String format, Object value)` Prints a formatted string using the specified format string and argument.
`void`	`printf(String format, Object[] values)` Prints a formatted string using the specified format string and arguments.
`void`	`println()` Prints a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it.
`void`	`println(Object value)` Prints the value and a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it.
`Object`	`run()` The main instance method of a script which has variables in scope as defined by the current Binding instance.
`void`	`run(File file, String[] arguments)` A helper method to allow scripts to be run taking command line arguments
`void`	`setBinding(Binding binding)`
`void`	`setProperty(String property, Object newValue)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GroovyObjectSupport`	`getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - protected Script()
  - protected Script(Binding binding)
- Method Detail
  - public Object evaluate(String expression)
    
    A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scope
    Parameters:
    expression - is the Groovy script expression to evaluate
  - public Object evaluate(File file)
    
    A helper method to allow the dynamic evaluation of groovy expressions using this scripts binding as the variable scope
    Parameters:
    file - is the Groovy script to evaluate
  - public Binding getBinding()
  - public Object getProperty(String property)
  - public Object invokeMethod(String name, Object args)
    
    Invoke a method (or closure in the binding) defined.
    Parameters:
    name - method to call
    args - arguments to pass to the method
    Returns:
    value
  - public void print(Object value)
    
    Prints the value to the current 'out' variable which should be a PrintWriter or at least have a print() method defined on it. If there is no 'out' property then print to standard out.
  - public void printf(String format, Object value)
    
    Prints a formatted string using the specified format string and argument.
    Parameters:
    format - the format to follow
    value - the value to be formatted
  - public void printf(String format, Object[] values)
    
    Prints a formatted string using the specified format string and arguments.
    Parameters:
    format - the format to follow
    values - an array of values to be formatted
  - public void println()
    
    Prints a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it. If there is no 'out' property then print to standard out.
  - public void println(Object value)
    
    Prints the value and a newline to the current 'out' variable which should be a PrintWriter or at least have a println() method defined on it. If there is no 'out' property then print to standard out.
  - public Object run()
    
    The main instance method of a script which has variables in scope as defined by the current Binding instance.
  - public void run(File file, String[] arguments)
    
    A helper method to allow scripts to be run taking command line arguments
  - public void setBinding(Binding binding)
  - public void setProperty(String property, Object newValue)

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class Script

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

protected Script()

protected Script(Binding binding)

Method Detail

public Object evaluate(String expression)

public Object evaluate(File file)

public Binding getBinding()

public Object getProperty(String property)

public Object invokeMethod(String name, Object args)

public void print(Object value)

public void printf(String format, Object value)

public void printf(String format, Object[] values)

public void println()

public void println(Object value)

public Object run()

public void run(File file, String[] arguments)

public void setBinding(Binding binding)

public void setProperty(String property, Object newValue)