summaryrefslogtreecommitdiffstats
path: root/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/param/IProblemPreferenceCompositeDescriptor.java
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/param/IProblemPreferenceCompositeDescriptor.java')
-rw-r--r--org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/param/IProblemPreferenceCompositeDescriptor.java51
1 files changed, 51 insertions, 0 deletions
diff --git a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/param/IProblemPreferenceCompositeDescriptor.java b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/param/IProblemPreferenceCompositeDescriptor.java
new file mode 100644
index 0000000..392e0a2
--- /dev/null
+++ b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/param/IProblemPreferenceCompositeDescriptor.java
@@ -0,0 +1,51 @@
+/*******************************************************************************
+ * Copyright (c) 2009,2010 QNX Software Systems
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * QNX Software Systems (Alena Laskavaia) - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.cdt.codan.core.param;
+
+/**
+ * Composite descriptor. For descriptors like map and list.
+ *
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ */
+public interface IProblemPreferenceCompositeDescriptor {
+ /**
+ * Available if type is composite. Returns value of subdescriptor with the
+ * name of key. For the "list" type key is the number (index).
+ *
+ * @param key
+ * - name of the subdescriptor.
+ * @return child preference of the given key
+ */
+ IProblemPreference getChildDescriptor(String key);
+
+ /**
+ * Available for composite types. Returns array of children.
+ *
+ * @return array of children. 0 size of none.
+ */
+ IProblemPreference[] getChildDescriptors();
+
+ /**
+ * Add preference
+ *
+ * @param preference
+ * @return added preference
+ */
+ IProblemPreference addChildDescriptor(IProblemPreference preference);
+
+ /**
+ * Remove preference
+ *
+ * @param preference
+ */
+ void removeChildDescriptor(IProblemPreference preference);
+}