Mongo.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2014, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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 org.jboss.javaee.mongodb;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import javax.enterprise.util.Nonbinding;
import javax.inject.Qualifier;

/**
 * This Qualifier is used to qualify an injected MongoDB element and to contain meta-data about the requested element used by
 * the corresponding producer in {@link MongoProducers}
 *
 * @author Antoine Sabot-Durand
 */

@Target(value = { TYPE, METHOD, PARAMETER, FIELD })
@Retention(value = RUNTIME)
@Documented
@Qualifier
public @interface Mongo {

    /**
     * @return the name of the MongoDB database for the injection point
     */
    @Nonbinding String db() default "default";

    /**
     * @return the name of the MongoDB collection for the injection point
     */
    @Nonbinding String collection() default "default";
}