| /* |
| * Copyright (c) 2007-2009, Osmorc Development Team |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without modification, |
| * are permitted provided that the following conditions are met: |
| * * Redistributions of source code must retain the above copyright notice, this list |
| * of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above copyright notice, this |
| * list of conditions and the following disclaimer in the documentation and/or other |
| * materials provided with the distribution. |
| * * Neither the name of 'Osmorc Development Team' nor the names of its contributors may be |
| * used to endorse or promote products derived from this software without specific |
| * prior written permission. |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY |
| * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL |
| * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR |
| * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |
| * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| package org.jetbrains.lang.manifest.header; |
| |
| import com.intellij.lang.PsiBuilder; |
| import com.intellij.lang.annotation.AnnotationHolder; |
| import com.intellij.psi.PsiReference; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.annotations.Nullable; |
| import org.jetbrains.lang.manifest.psi.Header; |
| import org.jetbrains.lang.manifest.psi.HeaderValuePart; |
| |
| /** |
| * @author Robert F. Beeger (robert@beeger.net) |
| */ |
| public interface HeaderParser { |
| /** |
| * Parses a header starting from a first token after semicolon and space. |
| */ |
| void parse(@NotNull PsiBuilder builder); |
| |
| /** |
| * Annotates the header with errors or any other useful information. |
| * Should return true if the element was annotated with errors. |
| */ |
| boolean annotate(@NotNull Header header, @NotNull AnnotationHolder holder); |
| |
| /** |
| * Returns the raw data of the header converted into some domain specific value (e.g. Version or VersionRange). |
| */ |
| @Nullable |
| Object getConvertedValue(@NotNull Header header); |
| |
| /** |
| * Returns references from a given header value, or empty array if none/not applicable. |
| */ |
| @NotNull |
| PsiReference[] getReferences(@NotNull HeaderValuePart headerValuePart); |
| } |