Habit (Javadoc | Loop Habit Tracker)

java.lang.Object
- org.isoron.uhabits.models.Habit

public class Habit
extends java.lang.Object

The thing that the user wants to track.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String HABIT_URI_FORMAT

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HABIT_URI_FORMAT`

Constructor Summary

Constructors
Constructor and Description

Habit()
Constructs a habit with default attributes.

Habit(Habit model)
Constructs a habit with the same attributes as the specified habit.

Constructors
Constructor and Description
`Habit()` Constructs a habit with default attributes.
`Habit(Habit model)` Constructs a habit with the same attributes as the specified habit.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearReminder()` Clears the reminder for a habit.
`void`	`copyFrom(Habit model)` Copies all the attributes of the specified habit into this habit
`java.lang.Integer`	`getArchived()` Flag that indicates whether the habit is archived.
`CheckmarkList`	`getCheckmarks()` List of checkmarks belonging to this habit.
`java.lang.Integer`	`getColor()` Color of the habit.
`java.lang.String`	`getDescription()` Description of the habit
`java.lang.Integer`	`getFreqDen()` Frequency denominator.
`java.lang.Integer`	`getFreqNum()` Frequency numerator.
`java.lang.Integer`	`getHighlight()` Not currently used.
`java.lang.Long`	`getId()`
`java.lang.String`	`getName()` Name of the habit
`ModelObservable`	`getObservable()`
`java.lang.Integer`	`getReminderDays()` Days of the week the reminder should be shown.
`java.lang.Integer`	`getReminderHour()` Hour of the day the reminder should be shown.
`java.lang.Integer`	`getReminderMin()` Minute the reminder should be shown.
`RepetitionList`	`getRepetitions()` List of repetitions belonging to this habit.
`ScoreList`	`getScores()` List of scores belonging to this habit.
`SQLiteStreakList`	`getStreaks()` List of streaks belonging to this habit.
`android.net.Uri`	`getUri()` Returns the public URI that identifies this habit
`boolean`	`hasReminder()` Checks whether the habit has a reminder set.
`boolean`	`isArchived()` Returns whether the habit is archived or not.
`void`	`setArchived(java.lang.Integer archived)`
`void`	`setColor(java.lang.Integer color)`
`void`	`setDescription(java.lang.String description)`
`void`	`setFreqDen(java.lang.Integer freqDen)`
`void`	`setFreqNum(java.lang.Integer freqNum)`
`void`	`setHighlight(java.lang.Integer highlight)`
`void`	`setId(java.lang.Long id)`
`void`	`setName(java.lang.String name)`
`void`	`setReminderDays(java.lang.Integer reminderDays)`
`void`	`setReminderHour(java.lang.Integer reminderHour)`
`void`	`setReminderMin(java.lang.Integer reminderMin)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HABIT_URI_FORMAT
```
public static final java.lang.String HABIT_URI_FORMAT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Habit
```
public Habit(Habit model)
```
    Constructs a habit with the same attributes as the specified habit.
    
    Parameters:
    
    model - the model whose attributes should be copied from
  - Habit
```
public Habit()
```
    Constructs a habit with default attributes.
    The habit is not archived, not highlighted, has no reminders and is placed in the last position of the list of habits.
- Method Detail
  - clearReminder
```
public void clearReminder()
```
    Clears the reminder for a habit. This sets all the related fields to null.
  - copyFrom
```
public void copyFrom(@NonNull
                     Habit model)
```
    Copies all the attributes of the specified habit into this habit
    
    Parameters:
    
    model - the model whose attributes should be copied from
  - getArchived
```
public java.lang.Integer getArchived()
```
    Flag that indicates whether the habit is archived. Archived habits are usually omitted from listings, unless explicitly included.
  - getCheckmarks
```
@NonNull
public CheckmarkList getCheckmarks()
```
    List of checkmarks belonging to this habit.
  - getColor
```
public java.lang.Integer getColor()
```
    Color of the habit.
    This number is not an android.graphics.Color, but an index to the activity color palette, which changes according to the theme. To convert this color into an android.graphics.Color, use ColorHelper.getColor(context, habit.color).
  - setColor
```
public void setColor(java.lang.Integer color)
```
  - getDescription
```
public java.lang.String getDescription()
```
    Description of the habit
  - setDescription
```
public void setDescription(java.lang.String description)
```
  - getFreqDen
```
public java.lang.Integer getFreqDen()
```
    Frequency denominator. If a habit is performed 3 times in 7 days, this field equals 7.
  - setFreqDen
```
public void setFreqDen(java.lang.Integer freqDen)
```
  - getFreqNum
```
public java.lang.Integer getFreqNum()
```
    Frequency numerator. If a habit is performed 3 times in 7 days, this field equals 3.
  - setFreqNum
```
public void setFreqNum(java.lang.Integer freqNum)
```
  - getHighlight
```
public java.lang.Integer getHighlight()
```
    Not currently used.
  - setHighlight
```
public void setHighlight(java.lang.Integer highlight)
```
  - getId
```
public java.lang.Long getId()
```
  - setId
```
public void setId(java.lang.Long id)
```
  - getName
```
public java.lang.String getName()
```
    Name of the habit
  - setName
```
public void setName(java.lang.String name)
```
  - getObservable
```
public ModelObservable getObservable()
```
  - getReminderDays
```
@NonNull
public java.lang.Integer getReminderDays()
```
    Days of the week the reminder should be shown. This field can be converted to a list of booleans using the method DateHelper.unpackWeekdayList and converted back to an integer by using the method DateHelper.packWeekdayList. If the habit has no reminders, this value should be ignored.
  - setReminderDays
```
public void setReminderDays(@NonNull
                            java.lang.Integer reminderDays)
```
  - getReminderHour
```
@Nullable
public java.lang.Integer getReminderHour()
```
    Hour of the day the reminder should be shown. If there is no reminder, this equals to null.
  - setReminderHour
```
public void setReminderHour(@Nullable
                            java.lang.Integer reminderHour)
```
  - getReminderMin
```
@Nullable
public java.lang.Integer getReminderMin()
```
    Minute the reminder should be shown. If there is no reminder, this equals to null.
  - setReminderMin
```
public void setReminderMin(@Nullable
                           java.lang.Integer reminderMin)
```
  - getRepetitions
```
@NonNull
public RepetitionList getRepetitions()
```
    List of repetitions belonging to this habit.
  - getScores
```
@NonNull
public ScoreList getScores()
```
    List of scores belonging to this habit.
  - getStreaks
```
@NonNull
public SQLiteStreakList getStreaks()
```
    List of streaks belonging to this habit.
  - getUri
```
public android.net.Uri getUri()
```
    Returns the public URI that identifies this habit
    
    Returns:
    
    the uri
  - hasReminder
```
public boolean hasReminder()
```
    Checks whether the habit has a reminder set.
    
    Returns:
    
    true if habit has reminder, false otherwise
  - isArchived
```
public boolean isArchived()
```
    Returns whether the habit is archived or not.
    
    Returns:
    
    true if archived
  - setArchived
```
public void setArchived(java.lang.Integer archived)
```

Class Habit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HABIT_URI_FORMAT

Constructor Detail

Habit

Habit

Method Detail

clearReminder

copyFrom

getArchived

getCheckmarks

getColor

setColor

getDescription

setDescription

getFreqDen

setFreqDen

getFreqNum

setFreqNum

getHighlight

setHighlight

getId

setId

getName

setName

getObservable

getReminderDays

setReminderDays

getReminderHour

setReminderHour

getReminderMin

setReminderMin

getRepetitions

getScores

getStreaks

getUri

hasReminder

isArchived

setArchived