Interface AuxiliaryProperties

public interface AuxiliaryProperties

Allow to store arbitrary properties in the project, similarly as AuxiliaryConfiguration. Used as backing store for ProjectUtils.getPreferences(org.netbeans.api.project.Project, java.lang.Class, boolean).

Note to API clients: do not use this interface directly, use ProjectUtils.getPreferences(org.netbeans.api.project.Project, java.lang.Class, boolean) instead.

Since:
1.16
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    get(String key, boolean shared)
    Get a property value.
    Iterable<String>
    listKeys(boolean shared)
    List all keys of all known properties.
    void
    put(String key, String value, boolean shared)
    Put a property value.

  • Method Details

    • get

      String get(String key, boolean shared)
      Get a property value.
      Parameters:
      key - name of the property
      shared - true to look in a sharable settings area, false to look in a private settings area
      Returns:
      value of the selected property, or null if not set.

    • put

      void put(String key, String value, boolean shared)
      Put a property value.
      Parameters:
      key - name of the property
      value - value of the property. null will remove the property.
      shared - true to look in a sharable settings area, false to look in a private settings area

    • listKeys

      Iterable<String> listKeys(boolean shared)
      List all keys of all known properties.
      Parameters:
      shared - true to look in a sharable settings area, false to look in a private settings area
      Returns:
      known keys.