OutlineParser.java

// Copyright 2012 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.collide.client.workspace.outline;


/**
 * Implementers build {@link OutlineNode}s from parsed Codemirror2 <code>Token</code>s.
 *
 */
public interface OutlineParser {

  /**
   * Performs cleanup.
   * 
   * <p>After cleanup is invoked this instance should never be used again.
   */
  void cleanup();

  /**
   * Gets the root outline node.
   */
  OutlineNode getRoot();

}