Index: OrdererMessages.java =================================================================== RCS file: /home/cvspublic/jakarta-hivemind/framework/src/java/org/apache/hivemind/order/OrdererMessages.java,v retrieving revision 1.7 diff -u -r1.7 OrdererMessages.java --- OrdererMessages.java 5 Jan 2005 18:05:17 -0000 1.7 +++ OrdererMessages.java 17 Mar 2005 03:26:12 -0000 @@ -20,72 +20,118 @@ /** * Messages for classes in this package. - * + * * @author Howard Lewis Ship */ final class OrdererMessages { - private static final MessageFormatter _formatter = - new MessageFormatter(OrdererMessages.class, "OrdererStrings"); + private static final MessageFormatter _formatter = new MessageFormatter(OrdererMessages.class, + "OrdererStrings"); - public static String duplicateName( - String objectType, - String objectName, - Object newObject, - Object existingObject) + /** + * Return the orderer formatted message for duplicate names using the duplicate-name key. + * + * @param objectType + * Type of object being ordered + * @param objectName + * Name of the duplicating object + * @param newObject + * New name for the ordered object - not used. + * @param existingObject + * Location where ordering duplication occurs + * @return Formatted message string for ordering duplicate name + */ + public static String duplicateName(String objectType, String objectName, Object newObject, + Object existingObject) { return _formatter.format( - "duplicate-name", - StringUtils.capitalize(objectType), - objectName, - HiveMind.getLocationString(existingObject)); - } - - public static String exception(String objectType, Throwable cause) - { - return _formatter.format("Orderer.exception", objectType, cause); - } - - public static String dupeLeader( - String objectType, - ObjectOrdering newOrdering, - ObjectOrdering existingLeader) - { - return _formatter.format( - "dupe-leader", - new Object[] { + "duplicate-name", StringUtils.capitalize(objectType), - newOrdering.getName(), - existingLeader.getName(), - HiveMind.getLocationString(existingLeader.getObject())}); + objectName, + HiveMind.getLocationString(existingObject)); } - public static String dupeTrailer( - String objectType, - ObjectOrdering newOrdering, - ObjectOrdering existingTrailer) + /** + * Return the orderer formatted message for an ordering exception using the exception key. + * + * @param objectType + * Type of object being ordered + * @param cause + * Cause of the exception + * @return Formatted message string for ordering exception + */ + public static String exception(String objectType, Throwable cause) { - return _formatter.format( - "dupe-trailer", - new Object[] { - StringUtils.capitalize(objectType), - newOrdering.getName(), - existingTrailer.getName(), - HiveMind.getLocationString(existingTrailer.getObject())}); + return _formatter.format("exception", objectType, cause); } - public static String dependencyCycle( - String objectType, - ObjectOrdering trigger, - Throwable cause) + /** + * Return an orderer formatted message for a duplicate first ordering + * + * @param objectType + * Type of object being ordered + * @param newOrdering + * Name of the new object to be ordered first + * @param existingLeader + * Existing object ordered first + * @return Formatted message string for ordering duplicate leader + */ + public static String dupeLeader(String objectType, ObjectOrdering newOrdering, + ObjectOrdering existingLeader) + { + return _formatter.format("dupe-leader", new Object[] + { StringUtils.capitalize(objectType), newOrdering.getName(), existingLeader.getName(), + HiveMind.getLocationString(existingLeader.getObject()) }); + } + + /** + * Return an orderer formatted message for a duplicate trailer ordering + * + * @param objectType + * Type of object being ordered + * @param newOrdering + * Name of the new object to be ordered last + * @param existingTrailer + * Existing object ordered as the trailer + * @return Formatted message string for ordering duplicate trailer + */ + public static String dupeTrailer(String objectType, ObjectOrdering newOrdering, + ObjectOrdering existingTrailer) + { + return _formatter.format("dupe-trailer", new Object[] + { StringUtils.capitalize(objectType), newOrdering.getName(), existingTrailer.getName(), + HiveMind.getLocationString(existingTrailer.getObject()) }); + } + + /** + * Return an orderer formatted message for a cyclical dependency in ordering + * + * @param objectType + * Type of object being ordered + * @param trigger + * Object which caused the cyclical dependency + * @param cause + * Cause of the dependency cycle + * @return Formatted message string for ordering dependency cycle + */ + public static String dependencyCycle(String objectType, ObjectOrdering trigger, Throwable cause) { return _formatter.format("dependency-cycle", objectType, trigger.getName(), cause); } - public static String badDependency( - String objectType, - String dependencyName, - ObjectOrdering ordering) + /** + * Return an orderer formatted message for a bad dependency in ordering + * + * @param objectType + * Type of object being ordered + * @param dependencyName + * Name of the unkonwn dependency + * @param ordering + * Ordering which references the unknown dependency + * @return Formatted message string for bad dependency in ordering + */ + public static String badDependency(String objectType, String dependencyName, + ObjectOrdering ordering) { return _formatter.format("bad-dependency", objectType, dependencyName, ordering.getName());