Interface ProgramUserData

  • All Superinterfaces:
    UserData

    public interface ProgramUserData
    extends UserData
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void endTransaction​(int transactionID)
      End a previously started transaction
      VoidPropertyMap getBooleanProperty​(java.lang.String owner, java.lang.String propertyName, boolean create)
      Get a address-based Boolean property map
      IntPropertyMap getIntProperty​(java.lang.String owner, java.lang.String propertyName, boolean create)
      Get a address-based Integer property map
      LongPropertyMap getLongProperty​(java.lang.String owner, java.lang.String propertyName, boolean create)
      Get a address-based Long property map
      ObjectPropertyMap getObjectProperty​(java.lang.String owner, java.lang.String propertyName, java.lang.Class<? extends Saveable> saveableObjectClass, boolean create)
      Get a address-based Saveable-object property map
      Options getOptions​(java.lang.String propertyListName)
      Get the property list for the given name.
      java.util.List<java.lang.String> getOptionsNames()
      Returns all properties lists contained by this domain object.
      java.util.List<PropertyMap> getProperties​(java.lang.String owner)
      Get all property maps associated with a specific owner.
      java.util.List<java.lang.String> getPropertyOwners()
      Returns list of all property owners for which property maps have been defined.
      StringPropertyMap getStringProperty​(java.lang.String owner, java.lang.String propertyName, boolean create)
      Get a address-based String property map
      int startTransaction()
      Start a transaction prior to changing any properties
    • Method Detail

      • startTransaction

        int startTransaction()
        Start a transaction prior to changing any properties
        Returns:
        transaction ID needed for endTransaction
      • endTransaction

        void endTransaction​(int transactionID)
        End a previously started transaction
        Parameters:
        transactionID -
      • getStringProperty

        StringPropertyMap getStringProperty​(java.lang.String owner,
                                            java.lang.String propertyName,
                                            boolean create)
                                     throws PropertyTypeMismatchException
        Get a address-based String property map
        Parameters:
        owner - name of property owner (e.g., plugin name)
        propertyName -
        create - creates the property map if it does not exist
        Returns:
        property map
        Throws:
        PropertyTypeMismatchException - if a conflicting map definition was found
      • getLongProperty

        LongPropertyMap getLongProperty​(java.lang.String owner,
                                        java.lang.String propertyName,
                                        boolean create)
                                 throws PropertyTypeMismatchException
        Get a address-based Long property map
        Parameters:
        owner - name of property owner (e.g., plugin name)
        propertyName -
        create - creates the property map if it does not exist
        Returns:
        property map
        Throws:
        PropertyTypeMismatchException - if a conflicting map definition was found
      • getIntProperty

        IntPropertyMap getIntProperty​(java.lang.String owner,
                                      java.lang.String propertyName,
                                      boolean create)
                               throws PropertyTypeMismatchException
        Get a address-based Integer property map
        Parameters:
        owner - name of property owner (e.g., plugin name)
        propertyName -
        create - creates the property map if it does not exist
        Returns:
        property map
        Throws:
        PropertyTypeMismatchException - if a conflicting map definition was found
      • getBooleanProperty

        VoidPropertyMap getBooleanProperty​(java.lang.String owner,
                                           java.lang.String propertyName,
                                           boolean create)
                                    throws PropertyTypeMismatchException
        Get a address-based Boolean property map
        Parameters:
        owner - name of property owner (e.g., plugin name)
        propertyName -
        create - creates the property map if it does not exist
        Returns:
        property map
        Throws:
        PropertyTypeMismatchException - if a conflicting map definition was found
      • getObjectProperty

        ObjectPropertyMap getObjectProperty​(java.lang.String owner,
                                            java.lang.String propertyName,
                                            java.lang.Class<? extends Saveable> saveableObjectClass,
                                            boolean create)
        Get a address-based Saveable-object property map
        Parameters:
        owner - name of property owner (e.g., plugin name)
        propertyName -
        create - creates the property map if it does not exist
        Returns:
        property map
        Throws:
        PropertyTypeMismatchException - if a conflicting map definition was found
      • getProperties

        java.util.List<PropertyMap> getProperties​(java.lang.String owner)
        Get all property maps associated with a specific owner.
        Parameters:
        owner - name of property owner (e.g., plugin name)
        Returns:
        list of property maps
      • getPropertyOwners

        java.util.List<java.lang.String> getPropertyOwners()
        Returns list of all property owners for which property maps have been defined.
      • getOptionsNames

        java.util.List<java.lang.String> getOptionsNames()
        Returns all properties lists contained by this domain object.
        Returns:
        all property lists contained by this domain object.
      • getOptions

        Options getOptions​(java.lang.String propertyListName)
        Get the property list for the given name.
        Parameters:
        propertyListName - name of property list