Package ghidra.program.model.util

Interface PropertyMapManager

  • All Known Implementing Classes:
    DBPropertyMapManager
    public interface PropertyMapManager
    Interface for managing a set of PropertyManagers.

    • Method Detail

      • createIntPropertyMap

        IntPropertyMap createIntPropertyMap​(java.lang.String propertyName)
                             throws DuplicateNameException
        Creates a new IntPropertyMap with the given name.
        Parameters:
        propertyName - the name for the new property.
        Throws:
        DuplicateNameException - thrown if a PropertyMap already exists with that name.

      • createLongPropertyMap

        LongPropertyMap createLongPropertyMap​(java.lang.String propertyName)
                               throws DuplicateNameException
        Creates a new LongPropertyMap with the given name.
        Parameters:
        propertyName - the name for the new property.
        Throws:
        DuplicateNameException - thrown if a PropertyMap already exists with that name.

      • createStringPropertyMap

        StringPropertyMap createStringPropertyMap​(java.lang.String propertyName)
                                   throws DuplicateNameException
        Creates a new StringPropertyMap with the given name.
        Parameters:
        propertyName - the name for the new property.
        Throws:
        DuplicateNameException - thrown if a PropertyMap already exists with that name.

      • createObjectPropertyMap

        ObjectPropertyMap createObjectPropertyMap​(java.lang.String propertyName,
                                          java.lang.Class<? extends Saveable> objectClass)
                                   throws DuplicateNameException
        Creates a new ObjectPropertyMap with the given name.
        Parameters:
        propertyName - the name for the new property.
        Throws:
        DuplicateNameException - thrown if a PropertyMap already exists with that name.

      • createVoidPropertyMap

        VoidPropertyMap createVoidPropertyMap​(java.lang.String propertyName)
                               throws DuplicateNameException
        Creates a new VoidPropertyMap with the given name.
        Parameters:
        propertyName - the name for the new property.
        Throws:
        DuplicateNameException - thrown if a PropertyMap already exists with that name.

      • getPropertyMap

        PropertyMap getPropertyMap​(java.lang.String propertyName)
        Returns the PropertyMap with the given name or null if no PropertyMap exists with that name.
        Parameters:
        propertyName - the name of the property to retrieve.

      • getIntPropertyMap

        IntPropertyMap getIntPropertyMap​(java.lang.String propertyName)
        Returns the IntPropertyMap associated with the given name.
        Parameters:
        propertyName - the name of the property to retrieve.
        Throws:
        TypeMismatchException - if a propertyMap named propertyName exists but is not an IntPropertyMap.

      • getLongPropertyMap

        LongPropertyMap getLongPropertyMap​(java.lang.String propertyName)
        Returns the LongPropertyMap associated with the given name.
        Parameters:
        propertyName - the name of the property to retrieve.
        Throws:
        TypeMismatchException - if a propertyMap named propertyName exists but is not an LongPropertyMap.

      • getStringPropertyMap

        StringPropertyMap getStringPropertyMap​(java.lang.String propertyName)
        Returns the StringPropertyMap associated with the given name.
        Parameters:
        propertyName - the name of the property to retrieve.
        Throws:
        TypeMismatchException - if a propertyMap named propertyName exists but is not a StringPropertyMap.

      • getObjectPropertyMap

        ObjectPropertyMap getObjectPropertyMap​(java.lang.String propertyName)
        Returns the ObjectPropertyMap associated with the given name.
        Parameters:
        propertyName - the name of the property to retrieve.
        Throws:
        TypeMismatchException - if a propertyMap named propertyName exists but is not an ObjectPropertyMap.

      • getVoidPropertyMap

        VoidPropertyMap getVoidPropertyMap​(java.lang.String propertyName)
        Returns the VoidPropertyMap associated with the given name.
        Parameters:
        propertyName - the name of the property to retrieve.
        Throws:
        TypeMismatchException - if a propertyMap named propertyName exists but is not a VoidPropertyMap.

      • removePropertyMap

        boolean removePropertyMap​(java.lang.String propertyName)
        Removes the PropertyMap with the given name.
        Parameters:
        propertyName - the name of the property to remove.
        Returns:
        true if a PropertyMap with that name was found (and removed)

      • propertyManagers

        java.util.Iterator<java.lang.String> propertyManagers()
        Returns an iterator over the names of all existing PropertyMaps.

      • removeAll

        void removeAll​(Address addr)
        Removes any property at the given address from all defined PropertyMaps.
        Parameters:
        addr - the address at which to remove all property values.

      • removeAll

        void removeAll​(Address startAddr,
               Address endAddr,
               TaskMonitor monitor)
        throws CancelledException
        Removes all properties in the given range from all user defined PropertyMaps.
        Parameters:
        startAddr - the first address in the range of addresses where propertie values are to be removed.
        endAddr - the last address in the range of addresses where propertie values are to be removed.
        monitor - monitors progress
        Throws:
        CancelledException - if the user cancelled the operation.