ch.rasc.extclassgenerator.ModelClientId Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2013-2016 Ralph Schaer 
 *
 * Licensed 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 ch.rasc.extclassgenerator;

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

/**
 * Denotes a field as the model's client id property. Alternative to
 * {@link Model#clientIdProperty()}. If a class has both this annotation takes precedence
 */
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface ModelClientId {
	/**
	 * If true the clientIdProperty is also added to the proxy's writer config
	 *
	 * 	 *   proxy: {
	 *     type: 'direct',
	 *     writer: {
	 *       clientIdProperty: 'clientId'
	 *     }
	 *   }
	 * 
	 *
	 * Default value is true.
	 */
	boolean configureWriter() default true;
}