org.apache.juneau.html.HtmlClassMeta Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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.apache.juneau.html;
import org.apache.juneau.*;
import org.apache.juneau.html.annotation.*;
import org.apache.juneau.internal.*;
/**
* Metadata on classes specific to the HTML serializers and parsers pulled from the {@link Html @Html} annotation on
* the class.
*/
public class HtmlClassMeta extends ClassMetaExtended {
private final Html html;
private final boolean noTables, noTableHeaders;
private final HtmlFormat format;
private final HtmlRender render;
/**
* Constructor.
*
* @param cm The class that this annotation is defined on.
*/
public HtmlClassMeta(ClassMeta cm) {
super(cm);
this.html = ClassUtils.getAnnotation(Html.class, getInnerClass());
if (html != null) {
format = html.format();
noTables = html.noTables();
noTableHeaders = html.noTableHeaders();
render = cm.getBeanContext().newInstance(HtmlRender.class, html.render());
} else {
format = HtmlFormat.HTML;
noTables = false;
noTableHeaders = false;
render = null;
}
}
/**
* Returns the {@link Html @Html} annotation defined on the class.
*
* @return The value of the annotation, or null if not specified.
*/
protected Html getAnnotation() {
return html;
}
/**
* Returns the {@link Html#format() @Html(format)} annotation defined on the class.
*
* @return The value of the annotation.
*/
protected HtmlFormat getFormat() {
return format;
}
/**
* Returns true if {@link #getFormat()} returns {@link HtmlFormat#XML}.
*
* @return true if {@link #getFormat()} returns {@link HtmlFormat#XML}.
*/
protected boolean isXml() {
return format == HtmlFormat.XML;
}
/**
* Returns true if {@link #getFormat()} returns {@link HtmlFormat#PLAIN_TEXT}.
*
* @return true if {@link #getFormat()} returns {@link HtmlFormat#PLAIN_TEXT}.
*/
protected boolean isPlainText() {
return format == HtmlFormat.PLAIN_TEXT;
}
/**
* Returns true if {@link #getFormat()} returns {@link HtmlFormat#HTML}.
*
* @return true if {@link #getFormat()} returns {@link HtmlFormat#HTML}.
*/
protected boolean isHtml() {
return format == HtmlFormat.HTML;
}
/**
* Returns true if {@link #getFormat()} returns {@link HtmlFormat#HTML_CDC}.
*
* @return true if {@link #getFormat()} returns {@link HtmlFormat#HTML_CDC}.
*/
protected boolean isHtmlCdc() {
return format == HtmlFormat.HTML_CDC;
}
/**
* Returns true if {@link #getFormat()} returns {@link HtmlFormat#HTML_SDC}.
*
* @return true if {@link #getFormat()} returns {@link HtmlFormat#HTML_SDC}.
*/
protected boolean isHtmlSdc() {
return format == HtmlFormat.HTML_SDC;
}
/**
* Returns the {@link Html#noTables() @Html(noTables)} annotation defined on the class.
*
* @return The value of the annotation.
*/
protected boolean isNoTables() {
return noTables;
}
/**
* Returns the {@link Html#noTableHeaders() @Html(noTableHeaders)} annotation defined on the class.
*
* @return The value of the annotation.
*/
public boolean isNoTableHeaders() {
return noTableHeaders;
}
/**
* Returns the {@link Html#render() @Html(render)} annotation defined on the class.
*
* @return The value of the annotation.
*/
public HtmlRender getRender() {
return render;
}
}