Package org.apache.juneau.bean.atom

Class Logo

java.lang.Object
org.apache.juneau.bean.atom.Common
org.apache.juneau.bean.atom.Logo
@Bean(typeName="logo") public class Logo extends Common
Represents a larger logo image for visual identification of a feed.

The logo element contains a URI reference to an image that provides visual identification for the feed. Logos are typically larger than icons and are suitable for display in feed readers, aggregators, and feed directories.

Per RFC 4287 recommendations:

  • Should have a 2:1 aspect ratio (twice as wide as tall)
  • Common formats: PNG, JPEG, GIF, SVG
  • Suitable for prominent display in feed readers
Schema

atomLogo = element atom:logo { atomCommonAttributes, (atomUri) }

Example:

Logo logo = new Logo("http://example.org/logo.png"); Feed feed = new Feed(...) .setLogo(logo);

Specification:

Represents an atomLogo construct in the RFC 4287 - Section 4.2.8 specification.

See Also:

  • Constructor Details

    • Logo

      public Logo(Object uri)
      Normal constructor.

      The value can be of any of the following types: URI, URL, String.
      Strings must be valid URIs.

      URIs defined by UriResolver can be used for values.

      Parameters:
      uri - The URI of the logo.

    • Logo

      public Logo()
      Bean constructor.

  • Method Details

    • getUri

      @Xml(format=TEXT) public URI getUri()
      Bean property getter: uri.

      The URI of the logo.

      Returns:
      The property value, or null if it is not set.

    • setUri

      public Logo setUri(Object value)
      Bean property setter: uri.

      The URI of the logo.

      The value can be of any of the following types: URI, URL, String.
      Strings must be valid URIs.

      URIs defined by UriResolver can be used for values.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setBase

      public Logo setBase(Object value)
      Description copied from class: Common
      Bean property setter: base.

      Sets the base URI for resolving relative URI references (xml:base attribute).

      The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.

      Example:

      Feed feed = new Feed(...) .setBase("http://example.org/");

      Overrides:
      setBase in class Common
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • setLang

      public Logo setLang(String value)
      Description copied from class: Common
      Bean property setter: lang.

      Sets the natural language of the element's content (xml:lang attribute).

      Example:

      Text title = new Text("text") .setText("Mon Blog") .setLang("fr");

      Overrides:
      setLang in class Common
      Parameters:
      value - The new value for this property (e.g., "en", "fr", "de", "en-US").
      Can be null to unset the property.
      Returns:
      This object.