Market.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol.common.model |
 |
 |
FreeCol |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| EXITS | Procedure exits | |
| COMMENTS | Comment lines | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| SIZE | Size of the file in bytes | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| RETURNS | Number of return points from functions | |
| FUNCTIONS | Number of function declarations | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0076 | JAVA0076 Use of magic number | |
| LINE_COMMENT | Number of line comments | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| OPERATORS | Number of operators | |
| LOOPS | Number of loops | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**
* Copyright (C) 2002-2007 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.model;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import net.sf.freecol.FreeCol;
import org.w3c.dom.Element;
/**
* This class implements a simple economic model whereby a market holds all
* goods that have been sold and the price of a particular type of good is
* determined solely by its availability in that market.
*/
public final class Market extends FreeColGameObject implements Ownable {
public static final int MINIMUM_PRICE = 1, MAXIMUM_PRICE = 19;
private Player owner;
private boolean initialized = false;
/**
* Constant for specifying the access to this <code>Market</code>
* when {@link #buy(GoodsType, int, Player) buying} and
* {@link #sell(GoodsType, int, Player, int) selling} goods.
*/
public static final int EUROPE = 0, CUSTOM_HOUSE = 1;
private final Map<GoodsType, MarketData> marketData = new HashMap<GoodsType, MarketData>();
private ArrayList<TransactionListener> transactionListeners =
new ArrayList<TransactionListener>();
// ----------------------------------------------------------- constructors
public Market(Game game, Player player) {
super(game);
this.owner = player;
/* create the objects to hold the market data for each type of
* goods and seed these objects with the initial amount of
* each type of goods
*/
for (GoodsType goodsType : FreeCol.getSpecification().getGoodsTypeList()) {
MarketData data = new MarketData();
data.setId(goodsType.getId());
if (goodsType.isStorable()) {
data.setAmountInMarket(goodsType.getInitialAmount());
data.setPaidForSale(goodsType.getInitialSellPrice());
data.setCostToBuy(goodsType.getInitialBuyPrice());
data.setOldPrice(goodsType.getInitialBuyPrice());
}
marketData.put(goodsType, data);
}
priceGoods();
}
/**
* Initiates a new <code>Market</code> from an
* XML representation.
*
* @param game The <code>Game</code> this object belongs to.
* @param in The input stream containing the XML.
* @throws XMLStreamException if a problem was encountered
* during parsing.
*/
public Market(Game game, XMLStreamReader in) throws XMLStreamException {
super(game, in);
readFromXML(in);
}
/**
* Initiates a new <code>Market</code> from an
* XML representation.
*
* @param game The <code>Game</code> this object belongs to.
* @param e An XML-element that will be used to initialize
* this object.
*/
public Market(Game game, Element e) {
super(game, e);
readFromXMLElement(e);
}
/**
* Initiates a new <code>Market</code>
* with the given ID. The object should later be
* initialized by calling either
* {@link #readFromXML(XMLStreamReader)} or
* {@link #readFromXMLElement(Element)}.
*
* @param game The <code>Game</code> in which this object belong.
* @param id The unique identifier for this object.
*/
public Market(Game game, String id) {
super(game, id);
}
// ------------------------------------------------------------ API methods
/**
* Return the market data for a type of goods.
*
* @param goodsType a <code>GoodsType</code> value
* @return a <code>MarketData</code> value
*/
public MarketData getMarketData(GoodsType goodsType) {
return marketData.get(goodsType);
}
/**
* Describe <code>putMarketData</code> method here.
*
* @param goodsType a <code>GoodsType</code> value
* @param data a <code>MarketData</code> value
*/
public void putMarketData(GoodsType goodsType, MarketData data) {
marketData.put(goodsType, data);
}
/**
* Gets the owner of this <code>Market</code>.
*
* @return The owner of this <code>Market</code>.
* @see #setOwner
*/
public Player getOwner() {
return owner;
}
/**
* Sets the owner of this <code>Market</code>.
*
* @param owner The <code>Player</code> that shall own this <code>Market</code>.
* @see #getOwner
*/
public void setOwner(Player owner) {
this.owner = owner;
}
/**
* Determines the cost to buy a single unit of a particular type of good.
*
* @param type a <code>GoodsType</code> value
* @return The cost to buy a single unit of the given type of goods.
*/
public int costToBuy(GoodsType type) {
MarketData data = marketData.get(type);
if (data == null) {
return 0;
} else {
return data.getCostToBuy();
}
}
/**
* Determines the price paid for the sale of a single unit of a particular
* type of good.
*
* @param type a <code>GoodsType</code> value
* @return The price for a single unit of the given type of goods
* if being sold.
*/
public int paidForSale(GoodsType type) {
MarketData data = marketData.get(type);
if (data == null) {
return 0;
} else {
return data.getPaidForSale();
}
}
/**
* Sells a particular amount of a particular type of good with the proceeds
* of the sale being paid to a particular player. The goods is
* sold using {@link #EUROPE} as the accesspoint for this market.
*
* @param type The type of goods to be sold.
* @param amount The amount of goods to be sold.
* @param player The player selling the goods
*/
public void sell(GoodsType type, int amount, Player player) {
sell(type, amount, player, Market.EUROPE);
}
/**
* Sells a particular amount of a particular type of good with the proceeds
* of the sale being paid to a particular player.
*
* @param type The type of goods to be sold.
* @param amount The amount of goods to be sold.
* @param player The player selling the goods
* @param marketAccess Place where goods are traded
*/
public void sell(GoodsType type, int amount, Player player, int marketAccess) {
if (player.canTrade(type, marketAccess)) {
int unitPrice = paidForSale(type);
int tax = player.getTax();
int incomeBeforeTaxes = getSalePrice(type, amount);
int incomeAfterTaxes = ((100 - tax) * incomeBeforeTaxes) / 100;
player.modifyGold(incomeAfterTaxes);
player.modifySales(type, amount);
player.modifyIncomeBeforeTaxes(type, incomeBeforeTaxes);
player.modifyIncomeAfterTaxes(type, incomeAfterTaxes);
for(TransactionListener listener : transactionListeners) {
listener.logSale(type, amount, unitPrice, tax);
}
amount = (int) player.getFeatureContainer()
.applyModifier(amount, "model.modifier.tradeBonus",
type, getGame().getTurn());
add(type, amount);
} else {
addModelMessage(this, ModelMessage.MessageType.WARNING,
"model.europe.market", "%goods%", type.getName());
}
}
/**
* Sells a particular amount of a particular type of good with the proceeds
* of the sale being paid to a particular player. The goods is
* sold using {@link #EUROPE} as the accesspoint for this market.
*
* @param goods The Goods object being sold.
* @param player the player selling the goods
* @throws NullPointerException if either (goods) or (player) is
* <TT>null</TT>
*/
public void sell(Goods goods, Player player) {
GoodsType type = goods.getType();
int amount = goods.getAmount();
goods.setLocation(null);
sell(type, amount, player, Market.EUROPE);
}
/**
* Buys a particular amount of a particular type of good with the cost
* being met by a particular player.
*
* @param goodsType the type of the good that is being bought
* @param amount the number of units of goods that are being bought
* @param player the player buying the goods
* @throws IllegalStateException If the <code>player</code> cannot afford
* to buy the goods.
*/
public void buy(GoodsType goodsType, int amount, Player player) {
int price = getBidPrice(goodsType, amount);
if (price > player.getGold()) {
throw new IllegalStateException();
}
int unitPrice = costToBuy(goodsType);
player.modifyGold(-price);
player.modifySales(goodsType, -amount);
player.modifyIncomeBeforeTaxes(goodsType, -price);
player.modifyIncomeAfterTaxes(goodsType, -price);
for(TransactionListener listener : transactionListeners) {
listener.logPurchase(goodsType, amount, unitPrice);
}
amount = (int) player.getFeatureContainer()
.applyModifier(amount, "model.modifier.tradeBonus",
goodsType, getGame().getTurn());
remove(goodsType, amount);
}
/**
* Add the given <code>Goods</code> to this <code>Market</code>.
*
* @param goodsType a <code>GoodsType</code> value
* @param amount The amount of goods.
*/
public void add(GoodsType goodsType, int amount) {
MarketData data = marketData.get(goodsType);
if (data == null) {
data = new MarketData();
marketData.put(goodsType, data);
}
int oldAmount = data.getAmountInMarket();
data.setAmountInMarket(oldAmount + amount);
priceGoods(goodsType, true);
}
/**
* Remove the given <code>Goods</code> from this <code>Market</code>.
* @param goodsType a <code>GoodsType</code> value
* @param amount The amount of goods.
*/
public void remove(GoodsType goodsType, int amount) {
MarketData data = marketData.get(goodsType);
if (data == null) {
data = new MarketData();
marketData.put(goodsType, data);
}
int oldAmount = data.getAmountInMarket();
/* this is a bottomless market: goods cannot be owed by the
* market */
data.setAmountInMarket(Math.max(oldAmount - amount, 100));
priceGoods(goodsType, true);
}
/**
* Gets the price of a given goods when the <code>Player</code> buys.
*
* @param type a <code>GoodsType</code> value
* @param amount The amount of goods.
* @return The bid price of the given goods.
*/
public int getBidPrice(GoodsType type, int amount) {
MarketData data = marketData.get(type);
if (data == null) {
return 0;
} else {
return (amount * data.getCostToBuy());
}
}
/**
* Gets the price of a given goods when the <code>Player</code> sells.
*
* @param type a <code>GoodsType</code> value
* @param amount The amount of goods.
* @return The sale price of the given goods.
*/
public int getSalePrice(GoodsType type, int amount) {
MarketData data = marketData.get(type);
if (data == null) {
return 0;
} else {
return (amount * data.getPaidForSale());
}
}
/**
* Gets the price of a given goods when the <code>Player</code> sells.
*
* @param goods a <code>Goods</code> value
* @return an <code>int</code> value
*/
public int getSalePrice(Goods goods) {
return getSalePrice(goods.getType(), goods.getAmount());
}
// -------------------------------------------------------- support methods
/**
* Adjusts the prices for all goods.
*/
private void priceGoods() {
priceGoods(initialized);
initialized = true;
}
/**
* Adjusts the prices for all goods.
*/
private void priceGoods(boolean addMessages) {
for (GoodsType goodsType : FreeCol.getSpecification().getGoodsTypeList()) {
if (goodsType.isStorable()) {
priceGoods(goodsType, addMessages);
}
}
}
/**
* Adjust the price for a particular type of goods.
*
* @param goodsType a <code>GoodsType</code> value
* @param addMessages a <code>boolean</code> value
*/
private void priceGoods(GoodsType goodsType, boolean addMessages) {
MarketData data = marketData.get(goodsType);
if (data != null) {
data.setOldPrice(data.getCostToBuy());
int newPrice = Math.round(goodsType.getInitialAmount() * goodsType.getInitialSellPrice() /
(float) data.getAmountInMarket());
if (newPrice + goodsType.getPriceDifference() > MAXIMUM_PRICE) {
data.setCostToBuy(MAXIMUM_PRICE);
data.setPaidForSale(MAXIMUM_PRICE - goodsType.getPriceDifference());
} else {
if (newPrice < MINIMUM_PRICE) {
newPrice = MINIMUM_PRICE;
}
data.setPaidForSale(newPrice);
data.setCostToBuy(data.getPaidForSale() + goodsType.getPriceDifference());
}
if (addMessages && owner != null && owner.getEurope() != null &&
goodsType.isStorable()) {
if (data.getOldPrice() > data.getCostToBuy()) {
addModelMessage(owner.getEurope(), ModelMessage.MessageType.MARKET_PRICES, goodsType,
"model.market.priceDecrease",
"%europe%", owner.getEurope().getName(),
"%goods%", goodsType.getName(),
"%buy%", String.valueOf(data.getCostToBuy()),
"%sell%", String.valueOf(data.getPaidForSale()));
} else if (data.getOldPrice() < data.getCostToBuy()) {
addModelMessage(owner.getEurope(), ModelMessage.MessageType.MARKET_PRICES, goodsType,
"model.market.priceIncrease",
"%europe%", owner.getEurope().getName(),
"%goods%", goodsType.getName(),
"%buy%", String.valueOf(data.getCostToBuy()),
"%sell%", String.valueOf(data.getPaidForSale()));
}
}
}
}
public void newTurn() {
for (GoodsType goodsType : FreeCol.getSpecification().getGoodsTypeList()) {
if (goodsType.isStorable()) {
MarketData data = marketData.get(goodsType);
if (data != null && data.getAmountInMarket() > goodsType.getInitialAmount()) {
remove(goodsType, 10);
}
}
}
}
/**
* This method writes an XML-representation of this object to
* the given stream.
*
* <br><br>
*
* Only attributes visible to the given <code>Player</code> will
* be added to that representation if <code>showAll</code> is
* set to <code>false</code>.
*
* @param out The target stream.
* @param player The <code>Player</code> this XML-representation
* should be made for, or <code>null</code> if
* <code>showAll == true</code>.
* @param showAll Only attributes visible to <code>player</code>
* will be added to the representation if <code>showAll</code>
* is set to <i>false</i>.
* @param toSavedGame If <code>true</code> then information that
* is only needed when saving a game is added.
* @throws XMLStreamException if there are any problems writing
* to the stream.
*/
protected void toXMLImpl(XMLStreamWriter out, Player player, boolean showAll, boolean toSavedGame)
throws XMLStreamException {
// Start element:
out.writeStartElement(getXMLElementTagName());
out.writeAttribute("ID", getId());
out.writeAttribute("owner", owner.getId());
for (MarketData data : marketData.values()) {
data.toXML(out, player, showAll, toSavedGame);
}
out.writeEndElement();
}
/**
* Initialize this object from an XML-representation of this object.
* @param in The input stream with the XML.
*/
protected void readFromXMLImpl(XMLStreamReader in) throws XMLStreamException {
setId(in.getAttributeValue(null, "ID"));
owner = getFreeColGameObject(in, "owner", Player.class);
while (in.nextTag() != XMLStreamConstants.END_ELEMENT) {
if (in.getLocalName().equals(MarketData.getXMLElementTagName())) {
MarketData data = new MarketData();
data.readFromXML(in);
marketData.put(FreeCol.getSpecification().getGoodsType(data.getId()), data);
}
}
priceGoods();
}
/**
* Returns the tag name of the root element representing this object.
*
* @return the tag name.
*/
public static String getXMLElementTagName() {
return "market";
}
/**
* Adds a transaction listener for notification of any transaction
*
* @param listener the listener
*/
public void addTransactionListener(TransactionListener listener) {
transactionListeners.add(listener);
}
/**
* Removes a transaction listener
*
* @param listener the listener
*/
public void removeTransactionListener(TransactionListener listener) {
transactionListeners.remove(listener);
}
/**
* Returns an array of all the TransactionListener added to this Market.
*
* @return all of the TransactionListener added or an empty array if no
* listeners have been added
*/
public TransactionListener[] getTransactionListener() {
return transactionListeners.toArray(new TransactionListener[0]);
}
// ---------------------------------------------------------- inner classes
}
The table below shows all metrics for Market.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 61.00 | Number of blocks | |
| BLOCK_COMMENT | 6.00 | Number of block comment lines | |
| COMMENTS | 232.00 | Comment lines | |
| COMMENT_DENSITY | 1.17 | Comment density | |
| COMPARISONS | 31.00 | Number of comparison operators | |
| CYCLOMATIC | 53.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 34.00 | Comments in declarations | |
| DOC_COMMENT | 221.00 | Number of javadoc comment lines | |
| ELOC | 198.00 | Effective lines of code | |
| EXEC_COMMENTS | 3.00 | Comments in executable code | |
| EXITS | 73.00 | Procedure exits | |
| FUNCTIONS | 29.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 68.04 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 87.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 3.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 2.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 2.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 555.00 | Number of lines in the source file | |
| LINE_COMMENT | 5.00 | Number of line comments | |
| LOC | 253.00 | Lines of code | |
| LOGICAL_LINES | 117.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 663.00 | Number of operands | |
| OPERATORS | 1233.00 | Number of operators | |
| PARAMS | 45.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1896.00 | Halstead program length | |
| PROGRAM_VOCAB | 276.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 42.00 | Number of return points from functions | |
| SIZE | 19452.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 229.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 47.00 | Number of unique operators | |
| WHITESPACE | 70.00 | Number of whitespace lines | |