org.sonar.api.resources
Class AbstractLanguage

java.lang.Object
  extended by org.sonar.api.resources.AbstractLanguage
All Implemented Interfaces:
BatchComponent, BatchExtension, Extension, Language, ServerComponent, ServerExtension
Direct Known Subclasses:
Java

public abstract class AbstractLanguage
extends Object
implements Language

Inherit this class to define a new language like PLSQL, PHP or C#

Since:
1.10

Constructor Summary
AbstractLanguage(String key)
          Better to use AbstractLanguage(key, name).
AbstractLanguage(String key, String name)
          Should be the constructor used to build an AbstractLanguage.
 
Method Summary
 boolean equals(Object o)
           
 String getKey()
          For example "java".
 String getName()
          For example "Java"
 int hashCode()
           
 void setName(String name)
          Sets the language name
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.sonar.api.resources.Language
getFileSuffixes
 

Constructor Detail

AbstractLanguage

public AbstractLanguage(String key)
Better to use AbstractLanguage(key, name). In this case, key and name will be the same


AbstractLanguage

public AbstractLanguage(String key,
                        String name)
Should be the constructor used to build an AbstractLanguage.

Parameters:
key - the key that will be used to retrieve the language. This key is important as it will be used to teint rules repositories...
name - the display name of the language in the interface
Method Detail

getKey

public String getKey()
For example "java". Should not be more than 5 chars.

Specified by:
getKey in interface Language

getName

public String getName()
For example "Java"

Specified by:
getName in interface Language

setName

public void setName(String name)
Sets the language name


equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009-2012 SonarSource. All Rights Reserved.