View Javadoc

1   /*--------------------------------------------------------------------------
2    *  Copyright 2010 utgenome.org
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *--------------------------------------------------------------------------*/
16  //--------------------------------------
17  // utgb-core Project
18  //
19  // OverlappingKmerIterator.java
20  // Since: 2010/10/05
21  //
22  //--------------------------------------
23  package org.utgenome.format.fasta;
24  
25  
26  /**
27   * For walking overlapping k-mer integers
28   * 
29   * @author leo
30   * 
31   */
32  public interface OverlappingKmerIterator {
33  
34  	/**
35  	 * Return the next K-mer, or null when no more K-mer can be generated .
36  	 * 
37  	 * @return next K-mer or null
38  	 */
39  	public CompactACGT nextKmer();
40  
41  }