View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shardingsphere.infra.algorithm.keygen.core;
19  
20  import org.apache.shardingsphere.infra.algorithm.core.ShardingSphereAlgorithm;
21  import org.apache.shardingsphere.infra.algorithm.core.context.AlgorithmSQLContext;
22  
23  import java.util.Collection;
24  
25  /**
26   * Key generate algorithm.
27   */
28  public interface KeyGenerateAlgorithm extends ShardingSphereAlgorithm {
29      
30      /**
31       * Generate keys.
32       * 
33       * @param context algorithm SQL context 
34       * @param keyGenerateCount key generate count
35       * @return generated keys
36       */
37      Collection<? extends Comparable<?>> generateKeys(AlgorithmSQLContext context, int keyGenerateCount);
38      
39      /**
40       * Judge whether support auto increment or not.
41       * 
42       * @return whether support auto increment or not
43       */
44      default boolean isSupportAutoIncrement() {
45          return false;
46      }
47  }