Package com.atlassian.confluence.pages
Class BlogPostsCalendar
java.lang.Object
com.atlassian.confluence.pages.BlogPostsCalendar
Helper bean that turns a list of blog posts into a monthly calendar.
-
Constructor Summary
ConstructorsConstructorDescriptionBlogPostsCalendar
(Date coversDate, List<BlogPost> blogPosts, String spaceKey, DateFormatter formatter) Construct a new calendar. -
Method Summary
Modifier and TypeMethodDescriptionGet the next year/month in the form yyyy/MMint
Gets the total number of days in the month being calendared.Get the next year/month in the form yyyy/MMgetPostsForDay
(int dayOfMonth) Get the posts made on a particular day of the monthGet all the posts for the monthGet the previous year/month in the form yyyy/MMint
Get the starting day of the month as an offset from Sunday (i.e.void
setFirstPostInNextMonth
(BlogPost firstPostInNextMonth) void
setLastPostInPreviousMonth
(BlogPost lastPostInPreviousMonth)
-
Constructor Details
-
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 calendaredblogPosts
- the blog posts to populate the calendarspaceKey
- the space key to build the calendar for
-
-
Method Details
-
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
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
Get all the posts for the month- Returns:
- the blog posts made in this calendar's month
-
formatMonthYear
-
getSpaceKey
-
getPreviousMonth
Get the previous year/month in the form yyyy/MM- Returns:
- the previous month for this calendar
-
getNextMonth
Get the next year/month in the form yyyy/MM- Returns:
- the next month for this calendar
-
getCurrentMonth
Get the next year/month in the form yyyy/MM- Returns:
- the current month og this calendar
-
setLastPostInPreviousMonth
-
setFirstPostInNextMonth
-
getLastPostInPreviousMonth
-
getFirstPostInNextMonth
-