com.google.code.rees.scope.conversation.annotations.ConversationField Maven / Gradle / Ivy
Show all versions of struts2-conversation-scope-plugin Show documentation
/*******************************************************************************
*
* Struts2-Conversation-Plugin - An Open Source Conversation- and Flow-Scope Solution for Struts2-based Applications
* =================================================================================================================
*
* Copyright (C) 2012 by Rees Byars
* http://code.google.com/p/struts2-conversation/
*
* **********************************************************************************************************************
*
* 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.
*
* **********************************************************************************************************************
*
* $Id: ConversationField.java reesbyars $
******************************************************************************/
package com.google.code.rees.scope.conversation.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Denotes a field as a conversation-scoped field. Depends
* on an
* {@link com.google.code.rees.scope.conversation.processing.InjectionConversationManager
* InjectionConversationManager} being used to manage conversations.
*
* @author rees.byars
* @see #name()
* @see #conversations()
*
*/
@Target({ java.lang.annotation.ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConversationField {
public static final String DEFAULT = "default";
/**
* The name of the field. If left blank, then the name of the
* field defaults to the name by which it is called in the code.
* For instance, for:
*
* @ConversationField String someString;
*
* the name would default to "someString". As well, the following will be
* treated as the same conversation field:
*
* @ConversationField String someString;
* @ConversationField(name="someString") String dumbString;
*
* because they have the same conversation field name.
*/
public abstract String name() default DEFAULT;
/**
* The conversations for which this field will be a member.
*
* In an action class annotated with the {@link ConversationController}
* annotation, the {@link #conversations()} field will default to that of
* the controller's conversations if left blank. If not in a
* ConversationController, then the conversations field must be specified in
* order to associate this field.
*/
public abstract String[] conversations() default {};
}