Interface FieldEnd<T>

  • Type Parameters:
    T - the type of the FieldEnd
    All Known Implementing Classes:
    FieldEndImpl

    @Deprecated(since="2.0",
                forRemoval=true)
    public interface FieldEnd<T>
    Deprecated, for removal: This API element is subject to removal in a future version.
    Represents a document field in a query and presents the operations available to querying against that field.
    • Method Detail

      • contains

        @Deprecated(since="2.0",
                    forRemoval=true)
        T contains​(String string)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks if a field contains a value
        Parameters:
        string - the value to check for
        Returns:
        T
        MongoDB documentation
        $regex
      • containsIgnoreCase

        @Deprecated(since="2.0",
                    forRemoval=true)
        T containsIgnoreCase​(String string)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks if a field contains a value ignoring the case of the values
        Parameters:
        string - the value to check for
        Returns:
        T
        MongoDB documentation
        $regex
      • endsWith

        @Deprecated(since="2.0",
                    forRemoval=true)
        T endsWith​(String suffix)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field ends with a value
        Parameters:
        suffix - the value to check
        Returns:
        T
        MongoDB documentation
        $regex
      • endsWithIgnoreCase

        @Deprecated(since="2.0",
                    forRemoval=true)
        T endsWithIgnoreCase​(String suffix)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field ends with a value ignoring the case of the values
        Parameters:
        suffix - the value to check
        Returns:
        T
        MongoDB documentation
        $regex
      • equalIgnoreCase

        @Deprecated(since="2.0",
                    forRemoval=true)
        T equalIgnoreCase​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field equals a value
        Parameters:
        val - the value to check
        Returns:
        T
        MongoDB documentation
        $eq
      • greaterThan

        @Deprecated(since="2.0",
                    forRemoval=true)
        T greaterThan​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field is greater than the value given
        Parameters:
        val - the value to check against
        Returns:
        T
        MongoDB documentation
        $gt
      • greaterThanOrEq

        @Deprecated(since="2.0",
                    forRemoval=true)
        T greaterThanOrEq​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field is greater than or equal to the value given
        Parameters:
        val - the value to check against
        Returns:
        T
        MongoDB documentation
        $gte
      • hasAllOf

        @Deprecated(since="2.0",
                    forRemoval=true)
        T hasAllOf​(Iterable<?> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field has all of the values listed.
        Parameters:
        values - the values to check against
        Returns:
        T
        MongoDB documentation
        $all
      • hasAnyOf

        @Deprecated(since="2.0",
                    forRemoval=true)
        T hasAnyOf​(Iterable<?> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field has any of the values listed.
        Parameters:
        values - the values to check against
        Returns:
        T
        MongoDB documentation
        $in
      • hasNoneOf

        @Deprecated(since="2.0",
                    forRemoval=true)
        T hasNoneOf​(Iterable<?> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field has none of the values listed.
        Parameters:
        values - the values to check against
        Returns:
        T
        MongoDB documentation
        $nin
      • hasThisOne

        @Deprecated(since="2.0",
                    forRemoval=true)
        T hasThisOne​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field has the value listed.
        Parameters:
        val - the value to check against
        Returns:
        T
        MongoDB documentation
        $eq
      • intersects

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T intersects​(Geometry geometry)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This performs a $geoIntersects query, searching documents containing any sort of GeoJson field and returning those where the given geometry intersects with the document shape. This includes cases where the data and the specified object share an edge.
        Parameters:
        geometry - the shape to use to query for any stored shapes that intersect
        Returns:
        T
        MongoDB documentation
        $geoIntersects
        Since server release
        2.4
      • intersects

        @Deprecated(since="2.0",
                    forRemoval=true)
        T intersects​(Geometry geometry)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This performs a $geoIntersects query, searching documents containing any sort of GeoJson field and returning those where the given geometry intersects with the document shape. This includes cases where the data and the specified object share an edge.
        Parameters:
        geometry - the shape to use to query for any stored shapes that intersect
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $geoIntersects
        Since server release
        2.4
      • intersects

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T intersects​(Geometry geometry,
                             CoordinateReferenceSystem crs)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This performs a $geoIntersects query, searching documents containing any sort of GeoJson field and returning those where the given geometry intersects with the document shape. This includes cases where the data and the specified object share an edge.
        Parameters:
        geometry - the shape to use to query for any stored shapes that intersect
        crs - the coordinate reference system to use with the query
        Returns:
        T
        MongoDB documentation
        $geometry
        Since server release
        2.4
      • intersects

        @Deprecated(since="2.0",
                    forRemoval=true)
        T intersects​(Geometry geometry,
                     CoordinateReferenceSystem crs)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This performs a $geoIntersects query, searching documents containing any sort of GeoJson field and returning those where the given geometry intersects with the document shape. This includes cases where the data and the specified object share an edge.
        Parameters:
        geometry - the shape to use to query for any stored shapes that intersect
        crs - the coordinate reference system to use with the query
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $geometry
        Since server release
        2.4
      • lessThan

        @Deprecated(since="2.0",
                    forRemoval=true)
        T lessThan​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field is less than the value given
        Parameters:
        val - the value to check against
        Returns:
        T
        MongoDB documentation
        $lt
      • lessThanOrEq

        @Deprecated(since="2.0",
                    forRemoval=true)
        T lessThanOrEq​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field is less than or equal to the value given
        Parameters:
        val - the value to check against
        Returns:
        T
        MongoDB documentation
        $lte
      • mod

        @Deprecated(since="2.0",
                    forRemoval=true)
        T mod​(long divisor,
              long remainder)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Select documents where the value of a field divided by a divisor has the specified remainder (i.e. perform a modulo operation to select documents)
        Parameters:
        divisor - the divisor to apply
        remainder - the remainder to check for
        Returns:
        T
        MongoDB documentation
        $mod
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        T near​(double longitude,
               double latitude,
               boolean spherical)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        longitude - the longitude
        latitude - the latitude
        spherical - if true, will use spherical geometry ($nearSphere) when analyzing documents
        Returns:
        T
        MongoDB documentation
        $near
        $nearSphere
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        T near​(double longitude,
               double latitude,
               double radius)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        longitude - the longitude
        latitude - the latitude
        radius - the max distance to consider
        Returns:
        T
        MongoDB documentation
        $near
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        T near​(double longitude,
               double latitude,
               double radius,
               boolean spherical)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        longitude - the longitude
        latitude - the latitude
        radius - the max distance to consider
        spherical - if true, will use spherical geometry ($nearSphere) when analyzing documents
        Returns:
        T
        MongoDB documentation
        $near
        $nearSphere
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T near​(Point point)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs a $near query to check for documents geographically close to the given Point - this Point represents a GeoJSON point type. These queries are only supported by MongoDB version 2.4 or greater.
        Parameters:
        point - the point to find results close to
        Returns:
        T
        MongoDB documentation
        $near
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        T near​(Point point)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs a $near query to check for documents geographically close to the given Point - this Point represents a GeoJSON point type. These queries are only supported by MongoDB version 2.4 or greater.
        Parameters:
        point - the point to find results close to
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $near
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T near​(Point point,
                       Double maxDistance,
                       Double minDistance)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        point - the point to find results close to
        maxDistance - the maximum distance in meters from the point
        minDistance - the minimum distance in meters from the point
        Returns:
        T
        Since:
        1.5
        MongoDB documentation
        $near
      • near

        @Deprecated(since="2.0",
                    forRemoval=true)
        T near​(Point point,
               Double maxDistance,
               Double minDistance)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        point - the point to find results close to
        maxDistance - the maximum distance in meters from the point
        minDistance - the minimum distance in meters from the point
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $near
      • nearSphere

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T nearSphere​(Point point,
                             Double maxDistance,
                             Double minDistance)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        point - the point to find results close to
        maxDistance - the maximum distance in meters from the point
        minDistance - the minimum distance in meters from the point
        Returns:
        T
        Since:
        1.5
        MongoDB documentation
        $nearSphere
      • nearSphere

        @Deprecated(since="2.0",
                    forRemoval=true)
        T nearSphere​(Point point,
                     Double maxDistance,
                     Double minDistance)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specifies a point for which a geospatial query returns the documents from nearest to farthest.
        Parameters:
        point - the point to find results close to
        maxDistance - the maximum distance in meters from the point
        minDistance - the minimum distance in meters from the point
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $nearSphere
      • not

        @Deprecated(since="2.0",
                    forRemoval=true)
        FieldEnd<T> not()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Negates the criteria applied to the field
        Returns:
        this
      • notEqual

        @Deprecated(since="2.0",
                    forRemoval=true)
        T notEqual​(Object val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field doesn't equal a value
        Parameters:
        val - the value to check
        Returns:
        T
        MongoDB documentation
        $ne
      • sizeEq

        @Deprecated(since="2.0",
                    forRemoval=true)
        T sizeEq​(int val)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks the size of a field.
        Parameters:
        val - the value to check against
        Returns:
        T
        MongoDB documentation
        $size
      • startsWith

        @Deprecated(since="2.0",
                    forRemoval=true)
        T startsWith​(String prefix)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field starts with a value
        Parameters:
        prefix - the value to check
        Returns:
        T
        MongoDB documentation
        $regex
      • startsWithIgnoreCase

        @Deprecated(since="2.0",
                    forRemoval=true)
        T startsWithIgnoreCase​(String prefix)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks that a field starts with a value ignoring the case of the values
        Parameters:
        prefix - the value to check
        Returns:
        T
        MongoDB documentation
        $regex
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T within​(Polygon boundary)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundary. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.
        Parameters:
        boundary - a polygon describing the boundary to search within.
        Returns:
        T
        MongoDB documentation
        $geoWithin
        Since server release
        2.4
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        T within​(Polygon boundary)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundary. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.
        Parameters:
        boundary - a polygon describing the boundary to search within.
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $geoWithin
        Since server release
        2.4
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T within​(MultiPolygon boundaries)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundaries. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.
        Parameters:
        boundaries - a multi-polygon describing the areas to search within.
        Returns:
        T
        MongoDB documentation
        $geoWithin
        Since server release
        2.6
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        T within​(MultiPolygon boundaries)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundaries. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.
        Parameters:
        boundaries - a multi-polygon describing the areas to search within.
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $geoWithin
        Since server release
        2.6
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T within​(Polygon boundary,
                         CoordinateReferenceSystem crs)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundary. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.
        Parameters:
        boundary - a polygon describing the boundary to search within.
        crs - the coordinate reference system to use
        Returns:
        T
        MongoDB documentation
        $geoWithin
        Since server release
        2.4
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        T within​(Polygon boundary,
                 CoordinateReferenceSystem crs)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundary. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.
        Parameters:
        boundary - a polygon describing the boundary to search within.
        crs - the coordinate reference system to use
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $geoWithin
        Since server release
        2.4
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        default T within​(MultiPolygon boundaries,
                         CoordinateReferenceSystem crs)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundaries. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.

        These queries are only compatible with MongoDB 2.6 or greater.

        Parameters:
        boundaries - a multi-polygon describing the areas to search within.
        crs - the coordinate reference system to use
        Returns:
        T
        MongoDB documentation
        $geoWithin
        Since server release
        2.6
      • within

        @Deprecated(since="2.0",
                    forRemoval=true)
        T within​(MultiPolygon boundaries,
                 CoordinateReferenceSystem crs)
        Deprecated, for removal: This API element is subject to removal in a future version.
        This runs the $geoWithin query, returning documents with GeoJson fields whose area falls within the given boundaries. When determining inclusion, MongoDB considers the border of a shape to be part of the shape, subject to the precision of floating point numbers.

        These queries are only compatible with MongoDB 2.6 or greater.

        Parameters:
        boundaries - a multi-polygon describing the areas to search within.
        crs - the coordinate reference system to use
        Returns:
        T
        Since:
        2.0
        MongoDB documentation
        $geoWithin
        Since server release
        2.6