Skip to content

Document throwing behavior of ConstantReader.read #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2017
Merged

Document throwing behavior of ConstantReader.read #242

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a468ac
Document throwing behavior of ConstantReader.read
natebosch Jul 21, 2017
c1395bb
Change to [] for the link
natebosch Jul 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions lib/src/constants.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ DartObject _getFieldRecursive(DartObject object, String field) {

/// A wrapper for analyzer's [DartObject] with a predictable high-level API.
///
/// Unlike [DartObject.getField], all `readX` methods attempt to access super
/// Unlike [DartObject.getField], the [read] method attempts to access super
/// classes for the field value if not found.
abstract class ConstantReader {
factory ConstantReader(DartObject object) =>
Expand Down Expand Up @@ -145,7 +145,11 @@ abstract class ConstantReader {
/// Returns whether this constant matches [checker].
bool instanceOf(TypeChecker checker);

/// Reads[ field] from the constant as another constant value.
/// Reads [field] from the constant as another constant value.
///
/// If the field is not present in the [DartObject] crawl up the chain of
/// super classes until it is found. If the field is not present throw a
/// [FormatException].
ConstantReader read(String field);

/// Returns as a revived meta class.
Expand Down