[iCal4j-commit] iCal4j/source/net/fortuna/ical4j/model ConstraintViolationException.java, 1.4, 1.5
Brought to you by:
fortuna
Menu
▾
▴
[iCal4j-commit] iCal4j/source/net/fortuna/ical4j/model ConstraintViolationException.java, 1.4, 1.5 CalendarDateFormatFactory.java, 1.9, 1.10 Calendar.java, 1.36, 1.37 ComponentFactory.java, 1.17, 1.18 Content.java, 1.11, 1.12 ComponentList.java, 1.13, 1.14 Component.java, 1.31, 1.32 CategoryList.java, 1.14, 1.15
|
From: Ben F. <fo...@us...> - 2009-06-17 14:46:21
|
Update of /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model In directory 23jxhf1.ch3.sourceforge.com:/tmp/cvs-serv5161/source/net/fortuna/ical4j/model Modified Files: ConstraintViolationException.java CalendarDateFormatFactory.java Calendar.java ComponentFactory.java Content.java ComponentList.java Component.java CategoryList.java Log Message: Checkstyle-based clean up Index: Calendar.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/Calendar.java,v retrieving revision 1.36 retrieving revision 1.37 diff -C2 -d -r1.36 -r1.37 *** Calendar.java 15 Jan 2009 10:40:13 -0000 1.36 --- Calendar.java 17 Jun 2009 12:30:00 -0000 1.37 *************** *** 123,130 **** --- 123,139 ---- private static final long serialVersionUID = -1654118204678581940L; + /** + * Begin token. + */ public static final String BEGIN = "BEGIN"; + /** + * Calendar token. + */ public static final String VCALENDAR = "VCALENDAR"; + /** + * End token. + */ public static final String END = "END"; *************** *** 161,164 **** --- 170,176 ---- * Creates a deep copy of the specified calendar. * @param c the calendar to copy + * @throws IOException where an error occurs reading calendar data + * @throws ParseException where calendar parsing fails + * @throws URISyntaxException where an invalid URI string is encountered */ public Calendar(Calendar c) throws ParseException, IOException, *************** *** 170,174 **** /** ! * @see java.lang.Object#toString() */ public final String toString() { --- 182,186 ---- /** ! * {@inheritDoc} */ public final String toString() { *************** *** 523,527 **** /** * Returns the mandatory prodid property. ! * @return */ public final ProdId getProductId() { --- 535,539 ---- /** * Returns the mandatory prodid property. ! * @return the PRODID property, or null if property doesn't exist */ public final ProdId getProductId() { *************** *** 531,535 **** /** * Returns the mandatory version property. ! * @return */ public final Version getVersion() { --- 543,547 ---- /** * Returns the mandatory version property. ! * @return the VERSION property, or null if property doesn't exist */ public final Version getVersion() { *************** *** 539,543 **** /** * Returns the optional calscale property. ! * @return */ public final CalScale getCalendarScale() { --- 551,555 ---- /** * Returns the optional calscale property. ! * @return the CALSCALE property, or null if property doesn't exist */ public final CalScale getCalendarScale() { *************** *** 547,551 **** /** * Returns the optional method property. ! * @return */ public final Method getMethod() { --- 559,563 ---- /** * Returns the optional method property. ! * @return the METHOD property, or null if property doesn't exist */ public final Method getMethod() { *************** *** 554,559 **** /** ! * Uses {@link EqualsBuilder} to test equality. Two calendars are equal if and only if their property lists and ! * component lists are equal. */ public final boolean equals(final Object arg0) { --- 566,570 ---- /** ! * {@inheritDoc} */ public final boolean equals(final Object arg0) { *************** *** 567,571 **** /** ! * Uses {@link HashCodeBuilder} to build hashcode. */ public final int hashCode() { --- 578,582 ---- /** ! * {@inheritDoc} */ public final int hashCode() { Index: Component.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/Component.java,v retrieving revision 1.31 retrieving revision 1.32 diff -C2 -d -r1.31 -r1.32 *** Component.java 23 Jan 2009 06:29:54 -0000 1.31 --- Component.java 17 Jun 2009 12:30:00 -0000 1.32 *************** *** 60,90 **** public abstract class Component implements Serializable { - /** - * - */ private static final long serialVersionUID = 4943193483665822201L; public static final String BEGIN = "BEGIN"; public static final String END = "END"; public static final String VEVENT = "VEVENT"; public static final String VTODO = "VTODO"; public static final String VJOURNAL = "VJOURNAL"; public static final String VFREEBUSY = "VFREEBUSY"; public static final String VTIMEZONE = "VTIMEZONE"; public static final String VALARM = "VALARM"; public static final String VAVAILABILITY = "VAVAILABILITY"; public static final String VVENUE = "VVENUE"; public static final String AVAILABLE = "AVAILABLE"; public static final String EXPERIMENTAL_PREFIX = "X-"; --- 60,123 ---- public abstract class Component implements Serializable { private static final long serialVersionUID = 4943193483665822201L; + /** + * Component start token. + */ public static final String BEGIN = "BEGIN"; + /** + * Component end token. + */ public static final String END = "END"; + /** + * Component token. + */ public static final String VEVENT = "VEVENT"; + /** + * Component token. + */ public static final String VTODO = "VTODO"; + /** + * Component token. + */ public static final String VJOURNAL = "VJOURNAL"; + /** + * Component token. + */ public static final String VFREEBUSY = "VFREEBUSY"; + /** + * Component token. + */ public static final String VTIMEZONE = "VTIMEZONE"; + /** + * Component token. + */ public static final String VALARM = "VALARM"; + /** + * Component token. + */ public static final String VAVAILABILITY = "VAVAILABILITY"; + /** + * Component token. + */ public static final String VVENUE = "VVENUE"; + /** + * Component token. + */ public static final String AVAILABLE = "AVAILABLE"; + /** + * Prefix for non-standard components. + */ public static final String EXPERIMENTAL_PREFIX = "X-"; *************** *** 112,116 **** /** ! * @see java.lang.Object#toString() */ public String toString() { --- 145,149 ---- /** ! * {@inheritDoc} */ public String toString() { *************** *** 189,194 **** /** ! * Uses {@link EqualsBuilder} to test equality. Two components are equal if and only if their name and property lists ! * are equal. */ public boolean equals(final Object arg0) { --- 222,226 ---- /** ! * {@inheritDoc} */ public boolean equals(final Object arg0) { *************** *** 202,206 **** /** ! * Uses {@link HashCodeBuilder} to build hashcode. */ public int hashCode() { --- 234,238 ---- /** ! * {@inheritDoc} */ public int hashCode() { *************** *** 212,215 **** --- 244,250 ---- * Create a (deep) copy of this component. * @return the component copy + * @throws IOException where an error occurs reading the component data + * @throws ParseException where parsing component data fails + * @throws URISyntaxException where component data contains an invalid URI */ public Component copy() throws ParseException, IOException, *************** *** 229,234 **** * transparency and anniversary-style dates do not affect the resulting * intersection. ! * @param period ! * @return */ public final PeriodList calculateRecurrenceSet(final Period period) { --- 264,269 ---- * transparency and anniversary-style dates do not affect the resulting * intersection. ! * @param period a range to calculate recurrences for ! * @return a list of periods */ public final PeriodList calculateRecurrenceSet(final Period period) { Index: CalendarDateFormatFactory.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/CalendarDateFormatFactory.java,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** CalendarDateFormatFactory.java 9 Jun 2009 14:04:42 -0000 1.9 --- CalendarDateFormatFactory.java 17 Jun 2009 12:30:00 -0000 1.10 *************** *** 74,81 **** * a SimpleDateFormat-compatible pattern * @return an optimized DateFormat instance if possible, otherwise a normal SimpleDateFormat instance - * @throws NullPointerException - * if the given pattern is null - * @throws IllegalArgumentException - * if the given pattern is invalid */ public static java.text.DateFormat getInstance(String pattern) { --- 74,77 ---- Index: Content.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/Content.java,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** Content.java 11 Jun 2009 11:31:35 -0000 1.11 --- Content.java 17 Jun 2009 12:30:00 -0000 1.12 *************** *** 52,61 **** /** ! * @return */ public abstract String getName(); /** ! * @return */ public abstract String getValue(); --- 52,61 ---- /** ! * @return the cotent name */ public abstract String getName(); /** ! * @return the content value */ public abstract String getValue(); Index: ComponentFactory.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/ComponentFactory.java,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** ComponentFactory.java 12 Jan 2009 04:42:15 -0000 1.17 --- ComponentFactory.java 17 Jun 2009 12:30:00 -0000 1.18 *************** *** 72,77 **** /** ! * @param name ! * @return */ public Component createComponent(final String name) { --- 72,77 ---- /** ! * @param name a component name ! * @return a new component instance of the specified type */ public Component createComponent(final String name) { *************** *** 166,170 **** /** ! * @return */ protected boolean allowIllegalNames() { --- 166,170 ---- /** ! * @return true if non-standard names are allowed, otherwise false */ protected boolean allowIllegalNames() { Index: ComponentList.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/ComponentList.java,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** ComponentList.java 12 Jan 2009 04:42:15 -0000 1.13 --- ComponentList.java 17 Jun 2009 12:30:00 -0000 1.14 *************** *** 65,69 **** /** * Creates a deep copy of the specified component list. ! * @param components */ public ComponentList(ComponentList components) throws ParseException, --- 65,72 ---- /** * Creates a deep copy of the specified component list. ! * @param components a component list to copy ! * @throws IOException where an error occurs reading component data ! * @throws ParseException where component data cannot be parsed ! * @throws URISyntaxException where component data contains an invalid URI */ public ComponentList(ComponentList components) throws ParseException, *************** *** 77,81 **** /** ! * @see java.util.AbstractCollection#toString() */ public final String toString() { --- 80,84 ---- /** ! * {@inheritDoc} */ public final String toString() { *************** *** 131,142 **** * Overrides superclass to throw an <code>IllegalArgumentException</code> where argument is not a * <code>net.fortuna.ical4j.model.Component</code>. * @see List#add(E) */ ! public final boolean add(final Object arg0) { ! if (!(arg0 instanceof Component)) { throw new IllegalArgumentException("Argument not a " + Component.class.getName()); } ! return super.add(arg0); } --- 134,147 ---- * Overrides superclass to throw an <code>IllegalArgumentException</code> where argument is not a * <code>net.fortuna.ical4j.model.Component</code>. + * @param component a component to add + * @return true if the object was added, otherwise false * @see List#add(E) */ ! public final boolean add(final Object component) { ! if (!(component instanceof Component)) { throw new IllegalArgumentException("Argument not a " + Component.class.getName()); } ! return super.add(component); } Index: ConstraintViolationException.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/ConstraintViolationException.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** ConstraintViolationException.java 12 Jan 2009 04:42:15 -0000 1.4 --- ConstraintViolationException.java 17 Jun 2009 12:30:00 -0000 1.5 *************** *** 43,49 **** public class ConstraintViolationException extends Exception { - /** - * - */ private static final long serialVersionUID = 6728653187698888940L; --- 43,46 ---- *************** *** 55,59 **** /** ! * @param message */ public ConstraintViolationException(String message) { --- 52,56 ---- /** ! * @param message an error message */ public ConstraintViolationException(String message) { Index: CategoryList.java =================================================================== RCS file: /cvsroot/ical4j/iCal4j/source/net/fortuna/ical4j/model/CategoryList.java,v retrieving revision 1.14 retrieving revision 1.15 diff -C2 -d -r1.14 -r1.15 *** CategoryList.java 12 Jan 2009 04:42:15 -0000 1.14 --- CategoryList.java 17 Jun 2009 12:30:00 -0000 1.15 *************** *** 85,89 **** /** ! * @param categoryStrings */ public CategoryList(String[] categoryValues) { --- 85,89 ---- /** ! * @param categoryValues an array of category values */ public CategoryList(String[] categoryValues) { *************** *** 92,96 **** /** ! * @see java.util.AbstractCollection#toString() */ public final String toString() { --- 92,96 ---- /** ! * {@inheritDoc} */ public final String toString() { |