/*
 * Copyright (C) 2009-2017 The Project Lombok Authors.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package lombok;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

Put on any field to make lombok build a standard setter.

Complete documentation is found at the project lombok features page for @Getter and @Setter.

Even though it is not listed, this annotation also has the onParam and onMethod parameter. See the full documentation for more details.

Example:

    private @Setter int foo;
will generate:
    public void setFoo(int foo) {
        this.foo = foo;
    }

This annotation can also be applied to a class, in which case it'll be as if all non-static fields that don't already have a Setter annotation have the annotation.

/** * Put on any field to make lombok build a standard setter. * <p> * Complete documentation is found at <a href="https://projectlombok.org/features/GetterSetter">the project lombok features page for &#64;Getter and &#64;Setter</a>. * <p> * Even though it is not listed, this annotation also has the {@code onParam} and {@code onMethod} parameter. See the full documentation for more details. * <p> * Example: * <pre> * private &#64;Setter int foo; * </pre> * * will generate: * * <pre> * public void setFoo(int foo) { * this.foo = foo; * } * </pre> * * <p> * This annotation can also be applied to a class, in which case it'll be as if all non-static fields that don't already have * a {@code Setter} annotation have the annotation. */
@Target({ElementType.FIELD, ElementType.TYPE}) @Retention(RetentionPolicy.SOURCE) public @interface Setter {
If you want your setter to be non-public, you can specify an alternate access level here.
Returns:The setter method will be generated with this access modifier.
/** * If you want your setter to be non-public, you can specify an alternate access level here. * * @return The setter method will be generated with this access modifier. */
lombok.AccessLevel value() default lombok.AccessLevel.PUBLIC;
Any annotations listed here are put on the generated method. The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).
up to JDK7:
@Setter(onMethod=@__({@AnnotationsGoHere}))
from JDK8:
@Setter(onMethod_={@AnnotationsGohere}) // note the underscore after onMethod.
Returns:List of annotations to apply to the generated setter method.
/** * Any annotations listed here are put on the generated method. * The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).<br> * up to JDK7:<br> * {@code @Setter(onMethod=@__({@AnnotationsGoHere}))}<br> * from JDK8:<br> * {@code @Setter(onMethod_={@AnnotationsGohere})} // note the underscore after {@code onMethod}. * * @return List of annotations to apply to the generated setter method. */
AnyAnnotation[] onMethod() default {};
Any annotations listed here are put on the generated method's parameter. The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).
up to JDK7:
@Setter(onParam=@__({@AnnotationsGoHere}))
from JDK8:
@Setter(onParam_={@AnnotationsGohere}) // note the underscore after onParam.
Returns:List of annotations to apply to the generated parameter in the setter method.
/** * Any annotations listed here are put on the generated method's parameter. * The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).<br> * up to JDK7:<br> * {@code @Setter(onParam=@__({@AnnotationsGoHere}))}<br> * from JDK8:<br> * {@code @Setter(onParam_={@AnnotationsGohere})} // note the underscore after {@code onParam}. * * @return List of annotations to apply to the generated parameter in the setter method. */
AnyAnnotation[] onParam() default {};
Placeholder annotation to enable the placement of annotations on the generated code.
Deprecated:Don't use this annotation, ever - Read the documentation.
/** * Placeholder annotation to enable the placement of annotations on the generated code. * @deprecated Don't use this annotation, ever - Read the documentation. */
@Deprecated @Retention(RetentionPolicy.SOURCE) @Target({}) @interface AnyAnnotation {} }