com.google.code.morphia.annotations.Entity Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2010 gauti.
 *
 *  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.
 *  under the License.
 */


package com.google.code.morphia.annotations;


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;

import com.google.code.morphia.mapping.Mapper;


/**
 * Allows marking and naming the collectionName
 *
 * @author Olafur Gauti Gudmundsson
 * @author Scott Hernandez
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
public @interface Entity {
  String value() default Mapper.IGNORED_FIELDNAME;

  CappedAt cap() default @CappedAt(0);

  //@Deprecated //to be replaced. This is a temp hack until polymorphism and discriminators are implemented
  boolean noClassnameStored() default false;

  //set slaveOk for queries for this Entity.
  boolean queryNonPrimary() default false;


  //any WriteConcern static string. Case insensitive. STRICT/SAFE, NORMAL, etc...
  String concern() default "";

}