Package com.atlassian.confluence.pages

Class BlogPostsCalendar

java.lang.Object

com.atlassian.confluence.pages.BlogPostsCalendar

public class BlogPostsCalendar
extends Object

Helper bean that turns a list of blog posts into a monthly calendar.

Constructor Summary

Constructors

Constructor	Description
BlogPostsCalendar(Date coversDate, List<BlogPost> blogPosts, String spaceKey, DateFormatter formatter)	Construct a new calendar.

Method Summary

Modifier and Type	Method	Description
String	formatMonthYear()
String	getCurrentMonth()	Get the next year/month in the form yyyy/MM
int	getDaysInMonth()	Gets the total number of days in the month being calendared.
BlogPost	getFirstPostInNextMonth()
BlogPost	getLastPostInPreviousMonth()
String	getNextMonth()	Get the next year/month in the form yyyy/MM
List<BlogPost>	getPostsForDay(int dayOfMonth)	Get the posts made on a particular day of the month
List<BlogPost>	getPostsForMonth()	Get all the posts for the month
String	getPreviousMonth()	Get the previous year/month in the form yyyy/MM
String	getSpaceKey()
int	getStartingDayOfMonth()	Get the starting day of the month as an offset from Sunday (i.e.
void	setFirstPostInNextMonth(BlogPost firstPostInNextMonth)
void	setLastPostInPreviousMonth(BlogPost lastPostInPreviousMonth)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlogPostsCalendar

public BlogPostsCalendar(Date coversDate,
                         List<BlogPost> blogPosts,
                         String spaceKey,
                         DateFormatter formatter)

Construct a new calendar. Takes a date that falls within the month being calendared, and a list of blog posts that are to populate the calendar. Any blog post falling outside the given month will be ignored quietly.

Parameters:

coversDate - a date falling within the month being calendared

blogPosts - the blog posts to populate the calendar

spaceKey - the space key to build the calendar for

Method Detail

getDaysInMonth

public int getDaysInMonth()

Gets the total number of days in the month being calendared.

Returns:

the total number of days in the month being calendared

getStartingDayOfMonth

public int getStartingDayOfMonth()

Get the starting day of the month as an offset from Sunday (i.e. Sunday is 0, Monday 1, etc.) This is NOT COMPATIBLE with the constants on the Calendar class.

Returns:

the starting day of the month as an offset from Sunday

getPostsForDay

public List<BlogPost> getPostsForDay(int dayOfMonth)

Get the posts made on a particular day of the month

Parameters:

dayOfMonth - the day of the month to get the posts for (starting at 1)

Returns:

the blog posts made on that day

getPostsForMonth

public List<BlogPost> getPostsForMonth()

Get all the posts for the month

Returns:

the blog posts made in this calendar's month

formatMonthYear

public String formatMonthYear()

getSpaceKey

public String getSpaceKey()

getPreviousMonth

public String getPreviousMonth()

Get the previous year/month in the form yyyy/MM

Returns:

the previous month for this calendar

getNextMonth

public String getNextMonth()

Get the next year/month in the form yyyy/MM

Returns:

the next month for this calendar

getCurrentMonth

public String getCurrentMonth()

Get the next year/month in the form yyyy/MM

Returns:

the current month og this calendar

setLastPostInPreviousMonth

public void setLastPostInPreviousMonth(BlogPost lastPostInPreviousMonth)

setFirstPostInNextMonth

public void setFirstPostInNextMonth(BlogPost firstPostInNextMonth)

getLastPostInPreviousMonth

public BlogPost getLastPostInPreviousMonth()

getFirstPostInNextMonth

public BlogPost getFirstPostInNextMonth()