com.phloc.html.hc.conversion.IHCConversionSettingsProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-html Show documentation

There is a newer version: 4.4.9

/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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 com.phloc.html.hc.conversion;

import javax.annotation.Nonnull;

import com.phloc.commons.xml.serialize.IXMLWriterSettings;
import com.phloc.css.writer.CSSWriterSettings;
import com.phloc.html.EHTMLVersion;
import com.phloc.html.hc.customize.IHCCustomizer;

/**
 * Provider interface for {@link HCConversionSettings} objects.
 *
 * @author Philip Helger
 */
public interface IHCConversionSettingsProvider
{
  /**
   * @return The HTML version to use. May not be null.
   */
  @Nonnull
  EHTMLVersion getHTMLVersion ();

  /**
   * Get the conversion settings using default pretty print mode.
   *
   * @return The non-null conversion settings object.
   */
  @Nonnull
  IHCConversionSettings getConversionSettings ();

  /**
   * Get the conversion settings.
   *
   * @param bPrettyPrint
   *        Should the output be indented and aligned (pretty printed)?
   * @return The non-null conversion settings object.
   */
  @Nonnull
  IHCConversionSettings getConversionSettings (boolean bPrettyPrint);

  @Nonnull
  IHCConversionSettingsProvider setXMLWriterSettings (@Nonnull IXMLWriterSettings aXMLWriterSettings);

  @Nonnull
  IHCConversionSettingsProvider setCSSWriterSettings (@Nonnull CSSWriterSettings aCSSWriterSettings);

  @Nonnull
  IHCConversionSettingsProvider setConsistencyChecksEnabled (boolean bConsistencyChecksEnabled);

  @Nonnull
  IHCConversionSettingsProvider setExtractOutOfBandNodes (boolean bExtractOutOfBandNodes);

  @Nonnull
  IHCConversionSettingsProvider setCustomizer (@Nonnull IHCCustomizer aCustomizer);
}