Author: scabanovich Date: 2011-10-20 15:49:40 -0400 (Thu, 20 Oct 2011) New Revision: 35863 Modified: trunk/cdi/plugins/org.jboss.tools.cdi.core/src/org/jboss/tools/cdi/core/extension/feature/IBeanKeyProvider.java Log: JBIDE-9244 https://issues.jboss.org/browse/JBIDE-9244 Comments to new interface are added. Modified: trunk/cdi/plugins/org.jboss.tools.cdi.core/src/org/jboss/tools/cdi/core/extension/feature/IBeanKeyProvider.java =================================================================== --- trunk/cdi/plugins/org.jboss.tools.cdi.core/src/org/jboss/tools/cdi/core/extension/feature/IBeanKeyProvider.java 2011-10-20 19:28:27 UTC (rev 35862) +++ trunk/cdi/plugins/org.jboss.tools.cdi.core/src/org/jboss/tools/cdi/core/extension/feature/IBeanKeyProvider.java 2011-10-20 19:49:40 UTC (rev 35863) @@ -1,3 +1,13 @@ +/******************************************************************************* + * Copyright (c) 2011 Red Hat, Inc. + * Distributed under license by Red Hat, Inc. All rights reserved. + * This program is 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: + * Red Hat, Inc. - initial API and implementation + ******************************************************************************/ package org.jboss.tools.cdi.core.extension.feature; import org.jboss.tools.cdi.core.IBean; @@ -2,3 +12,19 @@ +/** + * + * @author Viacheslav Kabanovich + * + */ public interface IBeanKeyProvider extends ICDIFeature { + /** + * Returns a key for the bean that allows to link relevant resources + * to the resource that declares the bean. Relevance is determined + * by consistency of the incremental validation. The key needs not to be unique, + * it just has to provide low probability of irrelevant links. + * Implementation does not have to provide key for any bean. + * Method may return null. + * + * @param bean + * @return a key for the bean to be used by the incremental validation for linking resources or null + */ public String getKey(IBean bean);