org.apache.juneau.annotation.Builder Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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. *
// ***************************************************************************************************************************
package org.apache.juneau.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
* Identifies a class as a builder for a POJO class.
*
* Example:
*
* // POJO class.
* @Builder (MyBeanBuilder.class )
* public class MyBean {
*
* // Read-only properties.
* public final String foo ;
* public final int bar ;
*
* // Constructor that takes in a builder.
* public MyBean(MyBeanBuilder b) {
* this .foo = b.foo;
* this .bar = b.bar;
* }
* }
*
* // Builder class.
* public class MyBeanBuilder {
* public String foo ;
* public int bar ;
*
* // Method that creates the bean.
* public MyBean build() {
* return new MyBean(this );
* }
*
* // Bean property setters.
* }
*
*
* See Also:
*
* - {@doc juneau-marshall.Transforms.PojoBuilders}
*
*/
@Documented
@Target({TYPE})
@Retention(RUNTIME)
@Inherited
public @interface Builder {
/**
* The builder for this class.
*/
Class value() default Null.class;
}