kv-4.0.9.src.oracle.kv.table.StringDef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-client Show documentation

Oracle NoSQL Database Client - supplies build and runtime support for the client side of the Oracle NoSQL Database. Note that a running Oracle NoSQL Database Server (store) is required to do anything meaningful with this client.

There is a newer version: 18.3.10

Show newest version

/*-
 *
 *  This file is part of Oracle NoSQL Database
 *  Copyright (C) 2011, 2016 Oracle and/or its affiliates.  All rights reserved.
 *
 * If you have received this file as part of Oracle NoSQL Database the
 * following applies to the work as a whole:
 *
 *   Oracle NoSQL Database server software is free software: you can
 *   redistribute it and/or modify it under the terms of the GNU Affero
 *   General Public License as published by the Free Software Foundation,
 *   version 3.
 *
 *   Oracle NoSQL Database 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
 *   Affero General Public License for more details.
 *
 * If you have received this file as part of Oracle NoSQL Database Client or
 * distributed separately the following applies:
 *
 *   Oracle NoSQL Database client software is free software: you can
 *   redistribute it and/or modify it under the terms of the Apache License
 *   as published by the Apache Software Foundation, version 2.0.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and/or the Apache License in the LICENSE file along with Oracle NoSQL
 * Database client or server distribution.  If not, see
 * 
 * or
 * .
 *
 * An active Oracle commercial licensing agreement for this product supersedes
 * these licenses and in such case the license notices, but not the copyright
 * notice, may be removed by you in connection with your distribution that is
 * in accordance with the commercial licensing terms.
 *
 * For more information please contact:
 *
 * [email protected]
 *
 */

package oracle.kv.table;

/**
 * StringDef is an extension of {@link FieldDef} to encapsulate a String.
 * It adds a minimum and maximum value range and type.
 * 
 * Comparisons to minimum and maxium values are done using
 * {@link String#compareTo}.
 *
 * @since 3.0
 */
public interface StringDef extends FieldDef {

    /**
     * Get the minimum value for the string.
     *
     * @return the minimum value for the instance if defined, otherwise null
     *
     * @deprecated as of release 4.0 it is no longer possible to specify
     * ranges on String types.
     */
    @Deprecated
    String getMin();

    /**
     * Get the maximum value for the string.
     *
     * @return the maximum value for the instance if defined, otherwise null
     *
     * @deprecated as of release 4.0 it is no longer possible to specify
     * ranges on String types.
     */
    @Deprecated
    String getMax();

    /**
     * @return true if the minimum is inclusive.  This value is only relevant
     * if {@link #getMin} returns a non-null value.
     *
     * @deprecated as of release 4.0 it is no longer possible to specify
     * ranges on String types.
     */
    @Deprecated
    boolean isMinInclusive();

    /**
     * @return true if the maximum is inclusive.  This value is only relevant
     * if {@link #getMax} returns a non-null value.
     *
     * @deprecated as of release 4.0 it is no longer possible to specify
     * ranges on String types.
     */
    @Deprecated
    boolean isMaxInclusive();

    /**
     * @return a deep copy of this object
     */
    @Override
    public StringDef clone();
}