org.smallmind.mongodb.throng.index.annotation.IndexOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-throng Show documentation

MongoDB ORM

There is a newer version: 6.2.0

/*
 * Copyright (c) 2007 through 2024 David Berkman
 *
 * This file is part of the SmallMind Code Project.
 *
 * The SmallMind Code Project is free software, you can redistribute
 * it and/or modify it under either, at your discretion...
 *
 * 1) The terms of GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * ...or...
 *
 * 2) The terms of the Apache License, Version 2.0.
 *
 * The SmallMind Code Project is distributed in the hope that it will
 * be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License or Apache License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and the Apache License along with the SmallMind Code Project. If not, see
 *  or .
 *
 * Additional permission under the GNU Affero GPL version 3 section 7
 * ------------------------------------------------------------------
 * If you modify this Program, or any covered work, by linking or
 * combining it with other code, such other code is not for that reason
 * alone subject to any of the requirements of the GNU Affero GPL
 * version 3.
 */
package org.smallmind.mongodb.throng.index.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface IndexOptions {

  boolean background () default false;

  boolean unique () default false;

  String name () default "";

  boolean sparse () default false;

  long expireAfterSeconds () default 0;

  int version () default 0;

  String weights () default "";

  String defaultLanguage () default "";

  String languageOverride () default "";

  int textVersion () default 0;

  int sphereVersion () default 0;

  int bits () default 0;

  double min () default -360;

  double max () default 360;

  double bucketSize () default 0;

  String storageEngine () default "";

  String partialFilterExpression () default "";

  Collation collation () default @Collation();

  String wildcardProjection () default "";

  boolean hidden () default false;
}