001    /*
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.     
018     */
019    package org.apache.wiki;
020    
021    
022    
023    /**
024     *  Defines an interface for transforming strings within a Wiki context.
025     *
026     *  @since 1.6.4
027     */
028    public interface StringTransmutator {
029        
030        /**
031         *  Returns a changed String, suitable for Wiki context.
032         *  
033         *  @param context WikiContext in which mutation is to be done
034         *  @param source  The source string.
035         *  @return The mutated string.
036         */
037        String mutate( WikiContext context, String source );
038    
039    }