Copyright (C) 2010 Olafur Gauti Gudmundsson

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.
/**
 * Copyright (C) 2010 Olafur Gauti Gudmundsson
 * <p/>
 * 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
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * 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.mongodb.morphia.annotations;


import org.mongodb.morphia.mapping.Mapper;

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;


Author:
Olafur Gauti Gudmundsson, Scott Hernandez/**
 * @author Olafur Gauti Gudmundsson
 * @author Scott Hernandez
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Reference {
    
Specify the concrete class to instantiate.
Deprecated:
unimplemented/**
     * Specify the concrete class to instantiate.
     *
     * @deprecated unimplemented
     */
    @Deprecated Class<?> concreteClass() default Object.class;

    
Specifies whether only _id should be stored versus storing a DBRef
/**
     * Specifies whether only _id should be stored versus storing a DBRef
     */
    boolean idOnly() default false;

    
Ignore any reference that don't resolve (aren't in mongodb)
/**
     * Ignore any reference that don't resolve (aren't in mongodb)
     */
    boolean ignoreMissing() default false;

    
Create a proxy around the reference which will be resolved on the first method call.
/**
     * Create a proxy around the reference which will be resolved on the first method call.
     */
    boolean lazy() default false;

    
The name of the Mongo value to store the field. Defaults to the name of the field being annotated.
/**
     * The name of the Mongo value to store the field. Defaults to the name of the field being annotated.
     */
    String value() default Mapper.IGNORED_FIELDNAME;
}