Mylyn WikiText

org.eclipse.mylyn.wikitext.core.parser.markup
Class IdGenerationStrategy

java.lang.Object
  extended by org.eclipse.mylyn.wikitext.core.parser.markup.IdGenerationStrategy
Direct Known Subclasses:
DefaultIdGenerationStrategy

public abstract class IdGenerationStrategy
extends Object

A strategy for generating IDs from text, follows the Strategy design pattern.

Author:
David Green

Constructor Summary
IdGenerationStrategy()
           
 
Method Summary
abstract  String generateId(String headingText)
          produce an id for use in an HTML anchor from heading text.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdGenerationStrategy

public IdGenerationStrategy()
Method Detail

generateId

public abstract String generateId(String headingText)
produce an id for use in an HTML anchor from heading text.

Parameters:
headingText - the text of the heading
Returns:
an Id, or null if no Id could be computed from the given text

Mylyn WikiText

Copyright © 2007, 2009 David Green and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html