com.helger.html.meta.IMetaElement Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.html.meta;

import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.collection.ext.ICommonsOrderedMap;
import com.helger.commons.collection.ext.ICommonsOrderedSet;
import com.helger.html.hc.IHCConversionSettingsToNode;
import com.helger.xml.microdom.IMicroNode;

/**
 * Represents a single meta element
 *
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
public interface IMetaElement extends IMetaElementDeclaration
{
  /**
   * Check if the meta tag is language independent.
   *
   * @return true if the meta tag is language independent,
   *         false if it is not
   */
  boolean isLanguageIndependent ();

  /**
   * @return A set with all locales a value is present
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsOrderedSet  getAllLocales ();

  /**
   * @return The content which was specified locale independent.
   */
  @Nullable
  String getContentLanguageIndependent ();

  /**
   * @return A non-null map from language to value.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsOrderedMap  getContent ();

  /**
   * Get the contents of this meta tag as a self contained list of meta tag
   * values.
   *
   * @return A non-null modifiable list of meta tags.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAsMetaElementValueList ();

  /**
   * Convert this meta element to an {@link IMicroNode}
   *
   * @param aConversionSettings
   *        The conversion settings to be used. May not be null.
   * @return null if this meta element contains no content.
   */
  @Nullable
  IMicroNode convertToNode (@Nonnull IHCConversionSettingsToNode aConversionSettings);
}