FXMLController.java

/*
 * Copyright (C) 2012-2013 The Cat Hive Developers.
 *
 * 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 com.cathive.fx.guice;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import com.cathive.fx.guice.controllerlookup.ControllerLookup;
import com.cathive.fx.guice.controllerlookup.IdentifiableController;
import com.google.inject.Scope;
import com.google.inject.ScopeAnnotation;

/**
 * This {@link Scope} annotation should be used on controllers which need to be
 * looked up via {@link ControllerLookup}.
 * 
 * @author Andy Till
 * 
 * @see IdentifiableController
 */
@Documented
@ScopeAnnotation
@Retention(RUNTIME) 
@Target({ TYPE, FIELD })
public @interface FXMLController {

    public String controllerId() default "";

}