/*
 * Copyright (c) 2009 The openGion Project.
 *
 * 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 org.opengion.fukurou.taglet;

import jdk.javadoc.doclet.Taglet;
import javax.lang.model.element.Element;
import java.util.Set;
import java.util.HashSet;
import java.util.List;
import java.util.Arrays;
import com.sun.source.doctree.DocTree;

/**
 * ソースコメントから、Javadoc を作成する場合のカスタムタグ情報を作成する
 * Taglet インターフェースの実装クラスを作成します。
 * og.formSample タグ(形式サンプル)を処理します。
 *
 * @version  6.9
 * @author   Kazuhiko Hasegawa
 * @since    JDK9.0,
 */
public class TagletFormSample implements Taglet {

	private static final String NAME   = "og.formSample";
	private static final String HEADER = "形式サンプル:";

	@Override
	public Set<Taglet.Location> getAllowedLocations​() {
		return new HashSet<Taglet.Location>( Arrays.asList( Taglet.Location.values() ) );
	}

	/**
	 * このカスタムタグの名前を返します。
	 *
	 * @return カスタムタグの名前
	 */
	@Override
	public String getName() {
		return NAME;
	}

	public boolean isInlineTag​() { return false; }

	/**
	 * このカスタムタグのタグ表現の配列を受け取り、
	 * 文字列としての表現を返し、生成されたページに出力します。
	 * このタグレットがインラインタグを表す場合、
	 * このメソッドは null を返します。
	 *
	 * @og.rev 6.0.2.0 (2014/09/19) インラインタグを処理できるように text(String) メソッド経由で出力する。
	 *
	 * @param tagTags	このカスタムタグを表すタグの配列
	 *
	 * @return このタグの文字列としての表現
	 * @see		com.sun.tools.doclets.Taglet#toString( Tag[] )
	 */
	@Override
	public String toString( final List<? extends DocTree> tags, final Element element ) {
		final StringBuilder buf = new StringBuilder( 200 )
			.append( "<dt><b>" ).append( HEADER ).append( "</b></dt>" )
			.append( "<dd><pre> " );

		if( !tags.isEmpty() ) {
			final String tree = tags.get(0).toString();
			buf.append( tree.replace( "@" + NAME , HEADER + "<pre>" ) );
		}

	//	for( final DocTree tree : tags ) {
	//		System.out.println( "【DocTree】" + );
	//	}

		return buf.append( "</pre></dd>\n" ).toString();
	}
}
