Package breitband.util

Class MapCredits

  • public class MapCredits
extends java.lang.Object
    The credits for a map.

    Contains information about the map's copyright and license

    Author:
    Luna Otte

    • Constructor Summary

      Constructors 
      Constructor Description
      MapCredits​(java.lang.String license, java.lang.String licenseShort, java.lang.String licenseLink, java.lang.String licenseVersion, java.lang.String copyright, java.lang.String copyrightLink)
      Constructs a new MapCredits instance with detailed information about the map's copyright and license.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCopyright()
      Gets the name of the copyright holder.
      java.lang.String getCopyrightLink()
      Returns the link to the map's license.
      java.lang.String getLicense()
      Gets the full name of the license.
      java.lang.String getLicenseLink()
      Gets the URL of the full text of the license.
      java.lang.String getLicenseShort()
      Gets the short form of the license name.
      java.lang.String getLicenseVersion()
      Gets the version of the license.
      java.lang.String toString()
      Formats the map credits as a string.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • MapCredits

        public MapCredits​(java.lang.String license,
                  java.lang.String licenseShort,
                  java.lang.String licenseLink,
                  java.lang.String licenseVersion,
                  java.lang.String copyright,
                  java.lang.String copyrightLink)
        Constructs a new MapCredits instance with detailed information about the map's copyright and license.
        Parameters:
        license - The full name of the license.
        licenseShort - The short form of the license name.
        licenseLink - A URL link to the full text of the license.
        licenseVersion - The version of the license.
        copyright - The name of the copyright holder.
        copyrightLink - A URL link to the copyright information.

    • Method Detail

      • getLicense

        public java.lang.String getLicense()
        Gets the full name of the license.
        Returns:
        The license name.

      • getLicenseShort

        public java.lang.String getLicenseShort()
        Gets the short form of the license name.
        Returns:
        The short form of the license.

      • getLicenseLink

        public java.lang.String getLicenseLink()
        Gets the URL of the full text of the license.
        Returns:
        The URL link to the license.

      • getLicenseVersion

        public java.lang.String getLicenseVersion()
        Gets the version of the license.
        Returns:
        The license version.

      • getCopyright

        public java.lang.String getCopyright()
        Gets the name of the copyright holder.
        Returns:
        The copyright holder's name.

      • getCopyrightLink

        public java.lang.String getCopyrightLink()
        Returns the link to the map's license.
        Returns:
        The license link

      • toString

        public java.lang.String toString()
        Formats the map credits as a string.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of the map credits