com.io7m.jstructural.annotated.SAImage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io7m-jstructural-core Show documentation
Java implementation of the structural document language (Core types)
There is a newer version: 5.0.0
Show newest version
/*
 * Copyright © 2014  http://io7m.com
 * 
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.jstructural.annotated;

import java.net.URI;

import com.io7m.jfunctional.OptionType;
import com.io7m.jnull.NullCheck;
import com.io7m.jnull.Nullable;

/**
 * An image.
 */

public final class SAImage implements
  SAParagraphContent,
  SALinkContent,
  SAListItemContent,
  SAFootnoteContent,
  SAFormalItemContent,
  SATableCellContent
{
  private final OptionType height;
  private final String              text;
  private final OptionType  type;
  private final URI                 uri;
  private final OptionType width;

  SAImage(
    final URI in_uri,
    final OptionType in_type,
    final OptionType in_width,
    final OptionType in_height,
    final String in_text)
  {
    this.uri = NullCheck.notNull(in_uri, "URI");
    this.type = NullCheck.notNull(in_type, "Type");
    this.width = NullCheck.notNull(in_width, "Width");
    this.height = NullCheck.notNull(in_height, "Height");
    this.text = NullCheck.notNull(in_text, "Text");
  }

  @Override public boolean equals(
    final @Nullable Object obj)
  {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (this.getClass() != obj.getClass()) {
      return false;
    }
    final SAImage other = (SAImage) obj;
    return this.height.equals(other.height)
      && this.text.equals(other.text)
      && this.type.equals(other.type)
      && this.uri.equals(other.uri)
      && this.width.equals(other.width);
  }

  @Override public  A footnoteContentAccept(
    final SAFootnoteContentVisitor v)
    throws Exception
  {
    return v.visitImage(this);
  }

  @Override public  A formalItemContentAccept(
    final SAFormalItemContentVisitor v)
    throws Exception
  {
    return v.visitImage(this);
  }

  /**
   * @return The image height specified, if any
   */

  public OptionType getHeight()
  {
    return this.height;
  }

  /**
   * @return The image text
   */

  public String getText()
  {
    return this.text;
  }

  /**
   * @return The term's type attribute
   */

  public OptionType getType()
  {
    return this.type;
  }

  /**
   * @return The image URI
   */

  public URI getURI()
  {
    return this.uri;
  }

  /**
   * @return The image width specified, if any
   */

  public OptionType getWidth()
  {
    return this.width;
  }

  @Override public int hashCode()
  {
    final int prime = 31;
    int result = 1;
    result = (prime * result) + this.height.hashCode();
    result = (prime * result) + this.text.hashCode();
    result = (prime * result) + this.type.hashCode();
    result = (prime * result) + this.uri.hashCode();
    result = (prime * result) + this.width.hashCode();
    return result;
  }

  @Override public  A linkContentAccept(
    final SALinkContentVisitor v)
    throws Exception
  {
    return v.visitImage(this);
  }

  @Override public  A listItemContentAccept(
    final SAListItemContentVisitor v)
    throws Exception
  {
    return v.visitImage(this);
  }

  @Override public  A paragraphContentAccept(
    final SAParagraphContentVisitor v)
    throws Exception
  {
    return v.visitImage(this);
  }

  @Override public  A tableCellContentAccept(
    final SATableCellContentVisitor v)
    throws Exception
  {
    return v.visitImage(this);
  }
}