    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 */
    019package org.apache.wiki.htmltowiki.syntax;
    020
    021import org.apache.wiki.htmltowiki.XHtmlElementToWikiTranslator;
    022import org.jdom2.Element;
    023import org.jdom2.JDOMException;
    024
    025import java.io.PrintWriter;
    026
    027
    028/**
    029 * Translates to wiki syntax from a {@code DD} element.
    030 */
    031public abstract class DdDecorator {
    032
    033    final protected PrintWriter out;
    034    final protected XHtmlElementToWikiTranslator chain;
    035
    036    protected DdDecorator( final PrintWriter out, final XHtmlElementToWikiTranslator chain ) {
    037        this.out = out;
    038        this.chain = chain;
    039    }
    040
    041    /**
    042     * Translates the given XHTML element into wiki markup.
    043     *
    044     * @param e XHTML element being translated.
    045     */
    046    public void decorate( final Element e ) throws JDOMException {
    047        out.print( markupDd() );
    048        chain.translate( e );
    049    }
    050
    051    /**
    052     * Wiki markup for a {@code dd} element.
    053     *
    054     * @return Wiki markup for a {@code dd} element.
    055     */
    056    protected abstract String markupDd();
    057
    058}