public class NacAlarm
extends java.lang.Object
implements android.os.Parcelable
Modifier and Type | Class and Description |
---|---|
static class |
NacAlarm.Builder
Helper to build an alarm.
|
static class |
NacAlarm.ChangeTracker
Track changes that were made to the alarm.
|
static interface |
NacAlarm.OnAlarmChangeListener
Definition for the change listener.
|
Modifier and Type | Field and Description |
---|---|
static android.os.Parcelable.Creator<NacAlarm> |
CREATOR
Generate parcel (required for Parcelable).
|
Constructor and Description |
---|
NacAlarm() |
NacAlarm(NacAlarm.Builder builder) |
Modifier and Type | Method and Description |
---|---|
boolean |
areDaysSelected() |
boolean |
canSnooze(NacSharedPreferences shared) |
void |
changed()
Call the listener when the alarm info has changed.
|
NacAlarm |
copy(int id)
Create a copy of this alarm with the given ID.
|
int |
describeContents()
Describe contents (required for Parcelable).
|
boolean |
equals(NacAlarm alarm)
Check if this alarm equals the given alarm.
|
java.lang.String |
getAudioSource() |
NacAlarm.ChangeTracker |
getChangeTracker() |
java.lang.String |
getClockTime(android.content.Context context) |
java.util.EnumSet<com.nfcalarmclock.util.NacCalendar.Day> |
getDays() |
boolean |
getEnabled() |
java.lang.String |
getFullTime(android.content.Context context) |
int |
getHour() |
int |
getId() |
int |
getId(java.util.Calendar c) |
java.lang.String |
getMediaPath() |
java.lang.String |
getMediaTitle() |
int |
getMediaType() |
java.lang.String |
getMeridian(android.content.Context context) |
int |
getMinute() |
java.lang.String |
getName() |
java.lang.String |
getNameNormalized() |
java.lang.String |
getNameNormalizedForMessage(int max) |
java.lang.String |
getNfcTagId() |
protected NacAlarm.OnAlarmChangeListener |
getOnAlarmChangeListener() |
boolean |
getRepeat() |
int |
getSnoozeCount(NacSharedPreferences shared) |
boolean |
getUseNfc() |
boolean |
getVibrate() |
int |
getVolume() |
boolean |
hasListener()
Check if alarm has a listener.
|
boolean |
hasMedia() |
boolean |
isActive() |
boolean |
isChangeTrackerLatched() |
boolean |
isInUse(NacSharedPreferences shared) |
boolean |
isSnoozed(NacSharedPreferences shared) |
void |
latchChangeTracker()
Latch the change tracker, so that if a change is made, it does not get
reset.
|
void |
print()
Print all values in the alarm object.
|
void |
resetChangeTracker()
Reset the change tracker.
|
void |
setAudioSource(java.lang.String source)
Set the audio source.
|
void |
setChangeTracker(NacAlarm.ChangeTracker change)
Set the change tracker.
|
void |
setDays(java.util.EnumSet<com.nfcalarmclock.util.NacCalendar.Day> days)
Set the days to the run the alarm.
|
void |
setDays(int value) |
void |
setEnabled(boolean enabled)
Set whether the alarm is enabled or not.
|
void |
setHour(int hour)
Set the hour.
|
void |
setId(int id)
Set the alarm ID.
|
void |
setIsActive(boolean active)
Set the flag indicating whether the alarm is active or not.
|
void |
setMedia(android.content.Context context,
java.lang.String path)
Set the sound to play when the alarm goes off.
|
void |
setMediaPath(java.lang.String path)
Set the sound to play when the alarm goes off.
|
void |
setMediaTitle(java.lang.String title)
Set the media title.
|
void |
setMediaType(int type)
Set the type of sound to play.
|
void |
setMinute(int minute)
Set the minute.
|
void |
setName(java.lang.String name)
Set the name of the alarm.
|
void |
setNfcTagId(java.lang.String tagId)
Set the NFC tag ID of the tag that will be used to dismiss the alarm.
|
void |
setOnAlarmChangeListener(NacAlarm.OnAlarmChangeListener listener)
Set a listener for when the alarm is changed.
|
void |
setRepeat(boolean repeat)
Set whether the alarm should repeat every week or not.
|
void |
setUseNfc(boolean useNfc)
Set whether the alarm should use NFC to dismiss or not.
|
void |
setVibrate(boolean vibrate)
Set whether the alarm should vibrate the phone or not.
|
void |
setVolume(int volume)
Set the volume level.
|
void |
toggleDay(com.nfcalarmclock.util.NacCalendar.Day day)
Toggle a day.
|
void |
toggleRepeat()
Toggle repeat.
|
void |
toggleToday()
Toggle today.
|
void |
toggleUseNfc()
Toggle use NFC.
|
void |
toggleVibrate()
Toggle vibrate.
|
void |
unlatchChangeTracker()
Unlatch the change tracker, so that if a change is made, it will get
reset.
|
boolean |
wasChanged() |
boolean |
wasUseNfcChanged() |
void |
writeToParcel(android.os.Parcel output,
int flags)
Write data into parcel (required for Parcelable).
|
public static final android.os.Parcelable.Creator<NacAlarm> CREATOR
public NacAlarm()
public NacAlarm(NacAlarm.Builder builder)
public boolean canSnooze(NacSharedPreferences shared)
public boolean areDaysSelected()
public void changed()
public NacAlarm copy(int id)
id
- The ID of the created alarm.public int describeContents()
describeContents
in interface android.os.Parcelable
public boolean equals(NacAlarm alarm)
alarm
- The alarm to compare against.public java.lang.String getAudioSource()
public NacAlarm.ChangeTracker getChangeTracker()
public java.lang.String getClockTime(android.content.Context context)
public java.util.EnumSet<com.nfcalarmclock.util.NacCalendar.Day> getDays()
public boolean getEnabled()
public java.lang.String getFullTime(android.content.Context context)
public int getHour()
public int getId()
public int getId(java.util.Calendar c)
c
- The calendar instance.public java.lang.String getMediaTitle()
public java.lang.String getMediaPath()
public int getMediaType()
public java.lang.String getMeridian(android.content.Context context)
public int getMinute()
public java.lang.String getName()
public java.lang.String getNameNormalized()
public java.lang.String getNameNormalizedForMessage(int max)
getNameNormalized()
public java.lang.String getNfcTagId()
protected NacAlarm.OnAlarmChangeListener getOnAlarmChangeListener()
public boolean getRepeat()
public int getSnoozeCount(NacSharedPreferences shared)
public boolean getUseNfc()
public boolean getVibrate()
public int getVolume()
public boolean hasListener()
public boolean hasMedia()
public boolean isActive()
public boolean isChangeTrackerLatched()
public boolean isSnoozed(NacSharedPreferences shared)
public boolean isInUse(NacSharedPreferences shared)
public void latchChangeTracker()
public void print()
public void resetChangeTracker()
public void setAudioSource(java.lang.String source)
source
- The audio source.public void setChangeTracker(NacAlarm.ChangeTracker change)
public void setDays(java.util.EnumSet<com.nfcalarmclock.util.NacCalendar.Day> days)
days
- The set of days to run the alarm on.public void setDays(int value)
setDays(EnumSet)
public void setEnabled(boolean enabled)
enabled
- True if the alarm is enabled and False otherwise.public void setHour(int hour)
hour
- The hour at which to run the alarm.public void setId(int id)
id
- The unique ID of the alarm.public void setIsActive(boolean active)
public void setMedia(android.content.Context context, java.lang.String path)
context
- The application context.path
- The path to sound to play.public void setMediaPath(java.lang.String path)
path
- The path to the media file to play when the alarm goes
off.public void setMediaTitle(java.lang.String title)
title
- The title of the media file to play.public void setMediaType(int type)
type
- The type of media file to play.public void setMinute(int minute)
minute
- The minute at which to run the alarm.public void setName(java.lang.String name)
name
- The alarm name.public void setNfcTagId(java.lang.String tagId)
tagId
- The ID of the NFC tag.public void setOnAlarmChangeListener(NacAlarm.OnAlarmChangeListener listener)
listener
- The change listener.public void setRepeat(boolean repeat)
repeat
- True if repeating the alarm after it runs, and False
otherwise.public void setUseNfc(boolean useNfc)
useNfc
- True if the phone should use NFC to dismiss, and False
otherwise.public void setVibrate(boolean vibrate)
vibrate
- True if the phone should vibrate when the alarm is
going off and false otherwise.public void setVolume(int volume)
volume
- The volume level.public void toggleDay(com.nfcalarmclock.util.NacCalendar.Day day)
public void toggleRepeat()
public void toggleUseNfc()
public void toggleVibrate()
public void toggleToday()
public void unlatchChangeTracker()
public boolean wasChanged()
public boolean wasUseNfcChanged()
public void writeToParcel(android.os.Parcel output, int flags)
writeToParcel
in interface android.os.Parcelable