com.adobe.epubcheck.opf.OPFReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of epubcheck Show documentation

EPUBCheck is a tool to validate the conformance of EPUB publications against the EPUB specifications. EPUBCheck can be run as a standalone command-line tool or used as a Java library.

There is a newer version: 5.1.0

Show newest version

/*
 * Copyright (c) 2007 Adobe Systems Incorporated
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package com.adobe.epubcheck.opf;

import io.mola.galimatias.GalimatiasParseException;
import io.mola.galimatias.URL;

// FIXME 2022 check if this cannot be handed in the XRefChecker instead
// FIXME 2022 use a builder pattern
public class OPFReference
{
  private final URL url;
  private final String type;
  private final String title;
  private final int lineNumber;
  private final int columnNumber;

  OPFReference(String type, String title, URL url, int lineNumber, int columnNumber)
  {
    // FIXME 2022 check preconditions
    this.type = type;
    this.title = title;
    this.url = url;
    this.lineNumber = lineNumber;
    this.columnNumber = columnNumber;
  }

  public String getType()
  {
    return type;
  }

  public String getTitle()
  {
    return title;
  }

  public URL getURL()
  {
    return url;
  }

  public URL getDocumentURL()
  {
    try
    {
      return url.withFragment(null);
    } catch (GalimatiasParseException e)
    {
      throw new AssertionError();
    }
  }

  public int getLineNumber()
  {
    return lineNumber;
  }

  public int getColumnNumber()
  {
    return columnNumber;
  }
}