Delegate (groovy 2.4.4 API)

groovy.lang.Delegate

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.

Element Summary

Optional Element Summary
Type	Name and Description
`boolean`	`deprecated` Whether to apply the delegate pattern to deprecated methods; to avoid compilation errors, this is ignored if the type of the delegate field is an interface and `interfaces=true`.
`Class[]`	`excludeTypes` List of interfaces containing method signatures to exclude when delegating.
`String[]`	`excludes` List of method and/or property names to exclude when delegating.
`Class[]`	`includeTypes` List of interfaces containing method signatures to exclude when delegating.
`String[]`	`includes` List of method and/or property names to include when delegating.
`boolean`	`interfaces` @default true Returns: true if owner class should implement interfaces implemented by field
`boolean`	`methodAnnotations` Whether to carry over annotations from the methods of the delegate to your delegating method.
`boolean`	`parameterAnnotations` Whether to carry over annotations from the parameters of delegate methods to your delegating method.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Element Detail
  - public boolean deprecated
    
    Whether to apply the delegate pattern to deprecated methods; to avoid compilation errors, this is ignored if the type of the delegate field is an interface and interfaces=true.
    Deprecated:
    @default false
    Returns:
    true if owner class should delegate to methods annotated with
  - public Class[] excludeTypes
    
    List of interfaces containing method signatures to exclude when delegating. Only one of 'includes', 'includeTypes', 'excludes', 'excludeTypes' should be used. If interfaces is true (the default), you will need to manually supply any methods excluded from delegation that are required for the interface. @default {}
    Since:
    2.3.0
  - public String[] excludes
    
    List of method and/or property names to exclude when delegating. Must not be used if 'includes' is used. For convenience, a String with comma separated names can be used in addition to an array (using Groovy's literal list notation) of String values. If interfaces is true (the default), you will need to manually supply any methods excluded from delegation that are required for the interface. @default {}
    Since:
    2.2.0
  - public Class[] includeTypes
    
    List of interfaces containing method signatures to exclude when delegating. Only one of 'includes', 'includeTypes', 'excludes', 'excludeTypes' should be used. If interfaces is true (the default), you will need to manually supply any methods excluded from delegation that are required for the interface. @default {}
    Since:
    2.3.0
  - public String[] includes
    
    List of method and/or property names to include when delegating. Must not be used if 'excludes' is used. For convenience, a String with comma separated names can be used in addition to an array (using Groovy's literal list notation) of String values. If interfaces is true (the default), you will need to manually supply any methods not included via delegation that are required for the interface. @default {}
    Since:
    2.2.0
  - public boolean interfaces
    
    @default true
    Returns:
    true if owner class should implement interfaces implemented by field
  - public boolean methodAnnotations
    
    Whether to carry over annotations from the methods of the delegate to your delegating method. Currently Closure annotation members are not supported. @default false
    Returns:
    true if generated delegate methods should keep method annotations
  - public boolean parameterAnnotations
    
    Whether to carry over annotations from the parameters of delegate methods to your delegating method. Currently Closure annotation members are not supported. @default false
    Returns:
    true if generated delegate methods should keep parameter annotations

Summary:
Optional

| Detail:
Element

[Java] Annotation Type Delegate

Element Summary

Inherited Methods Summary

Element Detail

public boolean deprecated

public Class[] excludeTypes

public String[] excludes

public Class[] includeTypes

public String[] includes

public boolean interfaces

public boolean methodAnnotations

public boolean parameterAnnotations