Package com.nomagic.persistence

Class XmiExporterDescription

  • All Implemented Interfaces:
    java.io.Serializable
    @OpenApiAll
public class XmiExporterDescription
extends java.lang.Object
implements java.io.Serializable
    Project version and required resources/plugins information.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private FormatVersion formatVersion  
      private java.lang.String mName  
      private java.util.Map<java.lang.String,​java.lang.String> mRequiredPluginMap
      List of required plugins, which are required for project.
      private java.util.List<com.nomagic.persistence.RequiredResourceDescriptor> mRequiredResources
      List of required resources, which are required for project loading.
      private java.lang.String mUMLNamespaceURI  
      private java.lang.String mVersion  
      private static long serialVersionUID  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRequiredPlugin​(java.lang.String name, java.lang.String version)
      Adds required plugin into map.
      void addRequiredResource​(java.lang.String suggestedId, java.lang.String name, java.lang.String value)
      Adds resource as required for project.
      boolean equals​(java.lang.Object o)  
      FormatVersion getFormatVersion()  
      java.lang.String getName()  
      java.util.Map<java.lang.String,​java.lang.String> getRequiredPluginMap()
      Returns list of map which plugins and version, which are required for project loading.
      java.util.List<com.nomagic.persistence.RequiredResourceDescriptor> getRequiredResources()
      Returns list of required resources IDs
      java.lang.String getUMLNamespaceURI()  
      java.lang.String getVersion()  
      int hashCode()  
      private void readObject​(java.io.ObjectInputStream stream)  
      void setRequiredPluginMap​(java.util.Map<java.lang.String,​java.lang.String> requiredPlugins)
      Set required plugins information
      void setRequiredResources​(java.util.List<com.nomagic.persistence.RequiredResourceDescriptor> requiredResources)
      Set required resources
      void setUMLNamespaceURI​(java.lang.String umlNamespaceURI)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • mName

        private final java.lang.String mName

      • mVersion

        private final java.lang.String mVersion

      • mUMLNamespaceURI

        private java.lang.String mUMLNamespaceURI

      • mRequiredPluginMap

        private java.util.Map<java.lang.String,​java.lang.String> mRequiredPluginMap
        List of required plugins, which are required for project. without these plugin project could miss some functionality.

      • mRequiredResources

        private java.util.List<com.nomagic.persistence.RequiredResourceDescriptor> mRequiredResources
        List of required resources, which are required for project loading. without these resources project may load incorrectly.

    • Constructor Detail

      • XmiExporterDescription

        @Deprecated
public XmiExporterDescription​(java.lang.String name,
                              java.lang.String version)
        Deprecated.
        use constructor with FileFormat arguments
        Constructor
        Parameters:
        name - exporter name
        version - exported version

      • XmiExporterDescription

        @Deprecated
public XmiExporterDescription​(java.lang.String name,
                              java.lang.String version,
                              @CheckForNull
                              java.lang.String umlURI)
        Deprecated.
        use constructor with FileFormat arguments
        Constructor
        Parameters:
        name - exported name
        version - exported version
        umlURI - uml metamodel uri

      • XmiExporterDescription

        public XmiExporterDescription​(java.lang.String name,
                              FormatVersion formatVersion)
        Constructor
        Parameters:
        name - exported name
        formatVersion - fileFormat version

      • XmiExporterDescription

        public XmiExporterDescription​(java.lang.String name,
                              FormatVersion formatVersion,
                              @CheckForNull
                              java.lang.String umlURI)
        Constructor
        Parameters:
        name - exported name
        formatVersion - fileFormat version
        umlURI - uml metamodel uri

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns:
        exported name

      • getVersion

        public java.lang.String getVersion()
        Returns:
        exporter application version. For full version check use #getFileFormat

      • getRequiredPluginMap

        public java.util.Map<java.lang.String,​java.lang.String> getRequiredPluginMap()
        Returns list of map which plugins and version, which are required for project loading.
        Returns:
        map of pluginName->Version, that is required for project loading

      • setRequiredPluginMap

        public void setRequiredPluginMap​(java.util.Map<java.lang.String,​java.lang.String> requiredPlugins)
        Set required plugins information
        Parameters:
        requiredPlugins - required plugins

      • addRequiredPlugin

        public void addRequiredPlugin​(java.lang.String name,
                              java.lang.String version)
        Adds required plugin into map.
        Parameters:
        name - name of plugin
        version - required version of plugin.

      • getRequiredResources

        public java.util.List<com.nomagic.persistence.RequiredResourceDescriptor> getRequiredResources()
        Returns list of required resources IDs
        Returns:
        list of required resources IDs.

      • setRequiredResources

        public void setRequiredResources​(java.util.List<com.nomagic.persistence.RequiredResourceDescriptor> requiredResources)
        Set required resources
        Parameters:
        requiredResources - required resources

      • addRequiredResource

        public void addRequiredResource​(java.lang.String suggestedId,
                                java.lang.String name,
                                java.lang.String value)
        Adds resource as required for project. resource ID, name and value are passed to create resource ID.
        Parameters:
        suggestedId - id of resource.
        name - name of resource.
        value - value of resource.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getUMLNamespaceURI

        @CheckForNull
public java.lang.String getUMLNamespaceURI()
        Returns:
        uml metamodel uri

      • setUMLNamespaceURI

        public void setUMLNamespaceURI​(java.lang.String umlNamespaceURI)

      • getFormatVersion

        public FormatVersion getFormatVersion()
        Returns:
        file format version.

      • readObject

        private void readObject​(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException